Commit graph

3 commits

Author SHA1 Message Date
Jon Siwek
54a0f3a5ae Changed make doc target to re-use Sphinx cache.
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.)
2012-10-24 17:04:44 -05:00
Jon Siwek
a43ed633a4 Changes to Broxygen master script package index
- Now only lists packages as those directories in the script hierarchy
  that contain an __load__.bro file.
- Script packages (dirs with a __load__.bro file), can now include a
  README (in reST format) that will automatically be appended under
  the link to a specific package in the master package index.
2011-12-02 13:59:33 -06:00
Jon Siwek
83aa4b535f Move sphinx source tree up a level. 2011-11-15 10:10:30 -06:00
Renamed from doc/scripts/group_index_generator.py (Browse further)