Submodule README conformity changes

Broccoli API reference docs now also get copied into sphinx output
directory by the broxygen target if they exist.
This commit is contained in:
Jon Siwek 2011-11-29 12:18:34 -06:00
parent 5991eaa564
commit 01693672bc
10 changed files with 24 additions and 11 deletions

@ -1 +1 @@
Subproject commit 34d90437403e4129468f89acce0bd1a99813a2f4
Subproject commit 82bd9613fb869e44f5f0d7929bdd9a88cde84077

@ -1 +1 @@
Subproject commit d281350dbcc19c24aa6b6d89a4edc08a5c74a790
Subproject commit d8f9d4698e8e02f493a669c5adcf897506671b5d

@ -1 +1 @@
Subproject commit ed4d4ce1add51f0e08e6e8d2f5f247c2cbb422da
Subproject commit 6771d28af299f025a701e67f51311513af1cbc22

@ -1 +1 @@
Subproject commit 7230a09a8c220d2117e491fdf293bf5c19819b65
Subproject commit 38890e851416fa9fc827a1d36f06c4cb9f7d4e69

View file

@ -51,6 +51,8 @@ add_custom_target(broxygen
COMMAND "${CMAKE_COMMAND}" -E create_symlink
${DOC_OUTPUT_DIR}/html
${CMAKE_BINARY_DIR}/html
# copy Broccoli API reference into output dir if it exists
COMMAND test -d ${CMAKE_BINARY_DIR}/aux/broccoli/doc/html && ( rm -rf ${CMAKE_BINARY_DIR}/html/broccoli-api && cp -r ${CMAKE_BINARY_DIR}/aux/broccoli/doc/html ${CMAKE_BINARY_DIR}/html/broccoli-api ) || true
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "[Sphinx] Generating HTML policy script docs"
# SOURCES just adds stuff to IDE projects as a convenience

View file

@ -0,0 +1 @@
../../../aux/binpac/README

View file

@ -0,0 +1 @@
../../../aux/bro-aux/README

View file

@ -0,0 +1 @@
../../../aux/broccoli/bindings/broccoli-ruby/README

View file

@ -0,0 +1 @@
../../../aux/broccoli/doc/broccoli-manual.rst

View file

@ -57,13 +57,20 @@ current, independent component releases.
.. toctree::
:maxdepth: 1
components/btest/README
components/broccoli/README
components/broccoli-python/README
components/broctl/README
components/capstats/README
components/pysubnettree/README
components/trace-summary/README
BinPAC - A protocol parser generator <components/binpac/README>
Broccoli - The Bro Client Communication Library (README) <components/broccoli/README>
Broccoli - User Manual <components/broccoli/broccoli-manual>
Broccoli Python Bindings <components/broccoli-python/README>
Broccoli Ruby Bindings <components/broccoli-ruby/README>
BroControl - Interactive Bro management shell <components/broctl/README>
Bro-Aux - Small auxiliary tools for Bro <components/bro-aux/README>
BTest - A unit testing framework <components/btest/README>
Capstats - Command-line packet statistic tool <components/capstats/README>
PySubnetTree - Python module for CIDR lookups<components/pysubnettree/README>
trace-summary - Script for generating break-downs of network traffic <components/trace-summary/README>
The `Broccoli API Reference <broccoli-api/index.html>`_ may also be of
interest.
Other Indices and References
----------------------------