Sphinx generic nodes "todo like" extension
Project description
A generic “todo like” nodes.
You love sphinx-ext-todo, and want more directives like this ?
This extension is for you.
install me with zc.buildout| pip | easy_install or clone and setup.py install|develop and add this to your conf.py
extensions = ['sphinxcontrib.gen_node'] gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False),]
explanations
gen_nodes is a list of tuples which for each element you could now add in your documentation like you do with ‘sphinx-ext-todo’:
a new sample_one directive
.. sample_one:: one thing
a new sample_onelist directive
.. sample_onelist::
The sample_onelist will not appear in your documentation if you set False in your conf.py gen_nodes = [(‘sample_one’, False, False, False),… on the second argument.
options :
sample_one is the name of your new admonition, you’ll write
.. sample_one:: A text hereThe first (True|False) argument enables the list Plz note that the form of a “list directive is always ‘namenode’+list ie
.. sample_onelist::the second (True|False) renders gathering by doc subtitle
the third (True|False) renders a paragraph with filename and line number (like on todo-list) with sphinxext.todo
install me
easy_install
easy_install sphinxcontrib-gen_node
pip
pip install Sphinx pip sphinxcontrib-gen_node
zc.buildout
eggs = Sphinx sphinxcontrib-gen_node
update your source/conf.py:
extensions = ['sphinxcontrib.gen_node'] gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False)]
Credits
Companies
Changelog
0.1 (2013-10-31)
Jean-Philippe Camguilhem <jean-philippe.camguilhem__at__makina-corpus.com>
Contributors
Jean-Philippe Camguilhem, Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-gen_node-0.1-20131031.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f4d6e62facbe81a28d33ec06b3685679d2302ee4b66b84af85a487ed1568187 |
|
MD5 | 2c2bb8082737b78088799f0867550223 |
|
BLAKE2b-256 | e6fe9e3d354cfb43e0a52f0dbe830faf6ec710b66d97a0c862dfb1ad78d8bdb9 |