Commit graph

25 commits

Author SHA1 Message Date
Jon Siwek
e88ac7221d Pass over doc xref links and linking style. 2014-01-21 11:32:55 -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
96ba5c82a3 Merge branch 'master' into topic/jsiwek/broxygen 2013-11-21 15:46:55 -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
Daniel Thayer
410e4babd0 Fix typos in sumstats doc and update doc test 2013-11-06 18:56:39 -06:00
Seth Hall
fab47cc749 Added a document for the SumStats framework. 2013-11-06 13:52:29 -05:00
Robin Sommer
8bfb81ca6f Moving the SQLite examples into separate Bro files to turn them into
sphinx-btest tests.

It's hard to make sure these are actually working as expected, but the
tests now at least make sure things parse correctly.
2013-10-18 14:18:33 -07:00
Robin Sommer
615cca8baa Merge remote-tracking branch 'origin/topic/dnthayer/doc-changes-for-2.2'
Snapshotting the work in this branch. I'll merge it again later as we
get closer to the release.

* origin/topic/dnthayer/doc-changes-for-2.2: (29 commits)
  Add README files for base/protocols
  Fix incorrect uses of reST directives
  Fix typos and formatting in the BiFs docs
  Fix typos and formatting in the base/utils docs
  Fix typos and formatting in the other protocol docs
  Fix typos and formatting in the ssl protocol docs
  Fix typos and formatting in the http protocol docs
  Fix typos and formatting in the ftp protocol docs
  Fix typos and formatting in the dns protocol docs
  Fix typos and formatting in the dhcp protocol docs
  Adjust line numbers to match changes in conn/main.bro
  Fix typos and formatting in the conn protocol docs
  Update FreeBSD install instructions
  Improvements to file analysis docs
  Add README files for most Bro frameworks
  Fix typos and formatting in various other framework docs
  Fix typos and formatting in the software framework docs
  Fix typos and formatting in the sumstats docs
  Fix typos and formatting in the packet filter docs
  Fix typos and formatting in the logging framework docs
  ...
2013-10-18 13:49:49 -07:00
Robin Sommer
27a8c5e568 Merge remote-tracking branch 'origin/topic/bernhard/input-documentation'
* origin/topic/bernhard/input-documentation:
  and provide a bit of motivation to try the last example.
  and restructure it a bit
  First try at sqlite reader/writer documentation
  add check that the SQLite reader is only used in MANUAL reading mode
  rename the dbname configuration option to tablename.
2013-10-18 13:19:37 -07:00
Bernhard Amann
613a04d176 and provide a bit of motivation to try the last example. 2013-10-17 16:00:22 -07:00
Bernhard Amann
dc685bbef3 and restructure it a bit 2013-10-17 15:52:00 -07:00
Bernhard Amann
5c2b2195f7 First try at sqlite reader/writer documentation 2013-10-17 15:41:58 -07:00
Daniel Thayer
bd47115c84 Convert File Analysis examples to using btest sphinx
Converted hard-coded examples in the File Analysis framework document
to using btest sphinx.
2013-10-09 23:41:37 -05:00
Daniel Thayer
b1a6692ebf Update installation instructions
Added a few missing packages to the install instructions.
Combined the two different sets of GeoIP install instructions into one
location and updated it.
Fixed a couple minor typos.
2013-10-09 17:33:40 -05:00
Daniel Thayer
489899bcac Update elasticsearch documentation
Fixed some broken links and a couple minor typos.
2013-10-08 17:45:49 -05:00
Daniel Thayer
bfbf1f7305 Add more links in the GeoLocation document 2013-09-19 17:34:07 -05:00
Daniel Thayer
78ef31577b Add links to Intelligence Framework documentation 2013-09-19 16:16:09 -05:00
Daniel Thayer
b02709f88f Fix broken links in the documentation
Also removed a duplicate link under "Script Reference".
2013-09-11 16:32:02 -05:00
Jon Siwek
db470a637a Documentation fixes.
This cleans up most of the warnings from sphinx (broken :doc: links,
broxygen role misuses, etc.).  The remaining ones should be harmless,
but not quick to silence.

I found that the README for each component was a copy from the actual
repo, so I turned those in to symlinks so they don't get out of date.
2013-09-03 15:59:40 -05:00
Robin Sommer
399899c49b Pass over the Using Bro section.
I edited the text little bit, reorganized the structure somewhat and
extended some parts. I've also simplified the tests a bit, using some
of the BTest tweaks commited in parallel.
2013-08-22 16:04:45 -07:00
Robin Sommer
1e9227a9e9 Applying doc updates from BIT-1063. (Anthony Verez)
notice.rst wasn't up-to-date in this branch, so I first copied it over
from master.
2013-08-22 08:57:45 -07:00
Robin Sommer
867e4b52d8 More doc reorg, and a light pass over the first 3 sections. 2013-08-19 22:08:30 -07:00
Robin Sommer
534d4934b7 Starting to put a new structure in place.
I'll go through the various parts next and clean things up for the new
structure.
2013-08-13 17:18:28 -07:00
Robin Sommer
aec77c7cfe Merge remote-tracking branch 'origin/master' into topic/documentation
Conflicts:
	doc/index.rst
	doc/scripts/builtins.rst
	testing/btest/btest.cfg
2013-08-12 14:03:49 -07:00
Robin Sommer
25bf563e1c Restructuring the main documentation index.
I'm merging in the remaining pieces from the former doc directory and
restructuring things into sub-directories.
2013-04-01 17:30:12 -07:00