setop
/
python-escpos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DOC add a todo directive to the documentation 

.. todo:: will create Todos that are listed in the TODO in the documentation
This commit is contained in:
Patrick Kanzler 2016-01-14 00:53:44 +01:00
parent 939e66834e
commit d00fc5016b
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/conf.py
View File

@ -34,8 +34,12 @@ extensions = [
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.todo',
] ]
# enable todos
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

5
doc/user/todo.rst
View File

@ -35,4 +35,9 @@ Design
* use something similar to the `capabilities` in escpos-php * use something similar to the `capabilities` in escpos-php
Todos in the codebase
~~~~~~~~~~~~~~~~~~~~~
.. todolist::