mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
54a0f3a5ae
To do this, the document root and autogenerated bro script docs are rsync'd in to Sphinx's working directory instead of a plain recursive copy. There are still some index files that are auto generated on each build and will trigger Sphinx to re-build them since it thinks they changed, but overall the build is much faster this way. One limitation of this is that old files in the Sphinx work dir don't automatically get cleaned up (e.g. if you remove some static documentation from the /doc it will still be in build/doc/sphinx-sources). So a `make docclean` or at least `make broxygenclean` is needed at least in that case. (For now, rsync --delete isn't the right answer since the destination of the autogenerated stuff overlaps with the document root, the separate rsyncs end up clobbering each other.)
72 lines
2.8 KiB
Python
Executable file
72 lines
2.8 KiB
Python
Executable file
#! /usr/bin/env python
|
|
|
|
# This script automatically generates a reST documents that lists
|
|
# a collection of Bro scripts that are "grouped" together.
|
|
# The summary text (##! comments) of the script is embedded in the list
|
|
#
|
|
# 1st argument is the file containing list of groups
|
|
# 2nd argument is the directory containing ${group}_files lists of
|
|
# scripts that belong to the group and ${group}_doc_names lists of
|
|
# document names that can be supplied to a reST :doc: role
|
|
# 3rd argument is a directory in which write a ${group}.rst file that contains
|
|
# reST style references to script docs along with summary text contained
|
|
# in original script. If ${group} ends with "index", then the file
|
|
# is always clobbered by this script, but for other unique group names,
|
|
# this script will append to existing files.
|
|
|
|
import sys
|
|
import os
|
|
import string
|
|
|
|
group_list = sys.argv[1]
|
|
file_manifest_dir = sys.argv[2]
|
|
output_dir = sys.argv[3]
|
|
|
|
def make_group_file_index(dir_name, group_name):
|
|
group_file = os.path.join(dir_name, group_name + ".rst")
|
|
|
|
if not os.path.exists(group_file):
|
|
if not os.path.exists(os.path.dirname(group_file)):
|
|
os.makedirs(os.path.dirname(group_file))
|
|
|
|
if group_name.endswith("index"):
|
|
with open(group_file, 'w') as f_group_file:
|
|
f_group_file.write(":orphan:\n\n")
|
|
title = "Package Index: %s\n" % os.path.dirname(group_name)
|
|
f_group_file.write(title);
|
|
for n in range(len(title)):
|
|
f_group_file.write("=")
|
|
f_group_file.write("\n");
|
|
|
|
return group_file
|
|
|
|
with open(group_list, 'r') as f_group_list:
|
|
for group in f_group_list.read().splitlines():
|
|
#print group
|
|
group_file = make_group_file_index(output_dir, group)
|
|
file_manifest = os.path.join(file_manifest_dir, group + "_files")
|
|
doc_manifest = os.path.join(file_manifest_dir, group + "_doc_names")
|
|
src_files = []
|
|
doc_names = []
|
|
|
|
with open(file_manifest, 'r') as f_file_manifest:
|
|
src_files = f_file_manifest.read().splitlines()
|
|
|
|
with open(doc_manifest, 'r') as f_doc_manifest:
|
|
doc_names = f_doc_manifest.read().splitlines()
|
|
|
|
for i in range(len(src_files)):
|
|
src_file = src_files[i]
|
|
#print "\t" + src_file
|
|
summary_comments = []
|
|
with open(src_file, 'r') as f_src_file:
|
|
for line in f_src_file:
|
|
sum_pos = string.find(line, "##!")
|
|
if sum_pos != -1:
|
|
summary_comments.append(line[(sum_pos+3):])
|
|
#print summary_comments
|
|
|
|
with open(group_file, 'a') as f_group_file:
|
|
f_group_file.write("\n:doc:`/scripts/%s`\n" % doc_names[i])
|
|
for line in summary_comments:
|
|
f_group_file.write(" " + line)
|