Teach sphinx a new ".. rootedliteralinclude::" directive.

It's like ".. literalinclude::" except the argument is an absolute path
which may contain environment variables to be be expanded when
generating documents.
This commit is contained in:
Jon Siwek 2013-01-09 11:16:43 -06:00
parent c453c228cb
commit 01090cf09f
2 changed files with 29 additions and 1 deletions

View file

@ -41,7 +41,10 @@ btest_tests="doc/sphinx"
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions += ['bro', 'rst_directive', 'sphinx.ext.todo', 'adapt-toc']
extensions += ['bro', 'rst_directive', 'sphinx.ext.todo', 'adapt-toc',
'rootedliteralinclude']
os.environ["BRO_SRC_ROOT"] = "@CMAKE_SOURCE_DIR@"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['sphinx-sources/_templates', 'sphinx-sources/_static']