[Bro-Dev] Autodoc: how to link to another script?
Jonathan Siwek
jsiwek at ncsa.illinois.edu
Wed Aug 10 11:36:31 PDT 2011
> what's the best way to link from one script to another?
The :doc: role: http://sphinx.pocoo.org/markup/inline.html
That can be embedded in any of the doc-style comments:
e.g. This renders a link (in the summary section) to the documentation for conn's main.bro:
##! :doc:`/scripts/base/protocols/conn/main`
And this would render a link to an index of all the script docs in that base/protocols/conn directory:
##! :doc:`/scripts/base/protocols/conn/index`
- Jon
More information about the bro-dev
mailing list