Update the generated script doc organization.

Added an additional master TOC index for Bro script packages that
automatically gets filled in at ``make doc`` time.  The master TOC
links to per-package indexes which contains links to all the scripts
contained within it along with their summary.  The per-package index
is also now automatically generated/derived from the path component
of the script passed into the rest_target() macro.
This commit is contained in:
Jon Siwek 2011-06-30 16:58:20 -05:00
parent fe5f4b8e53
commit 5a2cd265ab
22 changed files with 229 additions and 236 deletions

View file

@ -40,7 +40,7 @@ master_doc = 'index'
# General information about the project.
project = u'Bro'
copyright = u'2011, Jon Siwek'
copyright = u'2011, The Bro Project'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -178,7 +178,7 @@ htmlhelp_basename = 'Brodoc'
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Bro.tex', u'Bro Documentation',
u'Jon Siwek', 'manual'),
u'The Bro Project', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -211,5 +211,5 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'bro', u'Bro Documentation',
[u'Jon Siwek'], 1)
[u'The Bro Project'], 1)
]