Skip to main content

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 install|develop and add this to your

extensions = ['sphinxcontrib.gen_node']
gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False),]


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 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 here
  • The 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 sphinxcontrib-gen_node


pip install Sphinx
pip sphinxcontrib-gen_node


eggs =

update your source/

extensions = ['sphinxcontrib.gen_node']
gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False)]





0.1 (2013-10-31)

  • Jean-Philippe Camguilhem <>


Jean-Philippe Camguilhem, Author

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-gen_node, version 0.1-20131031
Filename, size File type Python version Upload date Hashes
Filename, size (12.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page