Commit graph

15 commits

Author SHA1 Message Date
Robin Sommer
21a0e12d82 Merge remote-tracking branch 'origin/topic/jdopheid/BIT-1242'
* origin/topic/jdopheid/BIT-1242:
  Improved the log file reference documentation
  Added missing log files prof, stderr, stdout
  Add a test that detects changes in the list of all Bro log files
  Broke down logs into grouped sections based on use & origin
  Adding deatils for modbus_register_change.log
  More updates to log files page: descriptions
  Changing name of file
  New page for List of Log files, linked to script-reference

Very nice. I've reorganized slightly more, mostly to shrink down the
"other" category: moved some of that into "Detection" and "Files" (the
latter is small, but will hopefully grow).

BIT-1242 #merged
2014-10-07 14:35:19 -07:00
Robin Sommer
175ff9cf2d Merge remote-tracking branch 'origin/topic/dnthayer/langref'
* origin/topic/dnthayer/langref:
  Minor improvements to script language reference docs
  Add more script language reference documentation
  Split the types and attributes reference doc into two docs

Wow, this is great!

BIT-1269 #merged
2014-10-07 14:18:08 -07:00
Daniel Thayer
f24adc1a95 Minor improvements to script language reference docs 2014-10-06 13:27:21 -05:00
Daniel Thayer
c16384b914 Improved the log file reference documentation
Reorganized the log file reference documentation, improved some of the
descriptions, and corrected a typo in a log filename.  Also removed
non-ascii characters that somehow got in the text.
2014-09-30 00:45:28 -05:00
Jeannette Dopheide
999f846abe Added missing log files prof, stderr, stdout 2014-09-29 10:50:46 -05:00
Jeannette Dopheide
16c70a5179 Broke down logs into grouped sections based on use & origin 2014-09-25 10:22:46 -05:00
Jeannette Dopheide
e402a224d8 Adding deatils for modbus_register_change.log 2014-09-23 08:53:54 -05:00
Jeannette Dopheide
14940c2d89 More updates to log files page: descriptions 2014-09-22 10:59:05 -05:00
Jeannette Dopheide
401ec39ce2 Changing name of file 2014-09-16 09:49:48 -05:00
Jeannette Dopheide
36efc8253d New page for List of Log files, linked to script-reference 2014-09-15 10:57:32 -05:00
Daniel Thayer
5c9a7a92a4 Add more script language reference documentation
Added new sections on operators, statements, and directives.  Also
improved the documentation on types and attributes by providing more
examples and added a chart on the top of each page with links to
each type and attribute for easier access to the information.
2014-09-04 13:32:24 -05:00
Daniel Thayer
22aa821506 Split the types and attributes reference doc into two docs
Also moved them up in the index so that the more fundamental material
comes before the more advanced material in the table of contents.
2014-07-31 10:49:33 -05:00
Daniel Thayer
0a90ddc1dd Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-updates 2013-12-18 14:35:22 -06:00
Jon Siwek
7e0864468c A couple documentation fixes.
- Move notice index wrapper doc to doc/script-reference -- doc/scripts
  no longer contains any static documentation because that location
  will be managed by Bro to generate per-script docs.

- :doc: references for generated per-script docs now need the ".bro"
  suffix.  (IMO this is better since it directly mirrors the actual
  script's file name and can't be confused w/ a package).
2013-11-21 15:59:07 -06:00
Jon Siwek
9967aea52c Integrate new Broxygen functionality into Sphinx.
Add a "broxygen" domain Sphinx extension w/ directives to allow
on-the-fly documentation to be generated w/ Bro and included in files.

This means all autogenerated reST docs are now done by Bro.  The odd
CMake/Python glue scipts which used to generate some portions are now
gone.  Bro and the Sphinx extension handle checking for outdated docs
themselves.

Parallel builds of `make doc` target should now work (mostly because
I don't think there's any tasks that can be done in parallel anymore).

Overall, this seems to simplify things and make the Broxygen-generated
portions of the documentation visible/traceable from the main Sphinx
source tree.  The one odd thing still is that per-script documentation
is rsync'd in to a shadow copy of the Sphinx source tree within the
build dir.  This is less elegant than using the new broxygen extension
to make per-script docs, but rsync is faster and simpler.  Simpler as in
less code because it seems like, in the best case, I'd need to write a
custom Sphinx Builder to be able to get that to even work.
2013-11-21 14:34:32 -06:00