tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: enable sphinx todo items

This commit is contained in:
Dietmar Maurer 2019-11-16 11:16:04 +01:00
parent c4f1b69f4e
commit 210cb53654
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf.py
View File

@ -30,7 +30,7 @@
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ["sphinx.ext.graphviz"] extensions = ["sphinx.ext.graphviz", "sphinx.ext.todo"]
# 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']
@ -124,7 +124,7 @@ pygments_style = 'sphinx'
# keep_warnings = False # keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = True
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------

3
docs/index.rst
View File

@ -12,6 +12,9 @@ Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free copy of the license is included in the section entitled "GNU Free
Documentation License". Documentation License".
.. todolist::
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
:caption: Table of Contents :caption: Table of Contents

3
docs/sysadmin.rst
View File

@ -26,4 +26,5 @@ please refer to the standard Debian documentation.
ZFS ZFS
~~~ ~~~
TODO .. todo:: Add local ZFS admin guide (local.zfs.adoc)