Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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 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

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

Release History

Release History

This version
History Node

0.1-20131031

History Node

0.1.dev0dev-20131031

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib-gen_node-0.1-20131031.zip (12.0 kB) Copy SHA256 Checksum SHA256 Source Oct 31, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting