From 210cb5365405d8026c15bed183db205523b1d86f Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sat, 16 Nov 2019 11:16:04 +0100 Subject: [PATCH] docs: enable sphinx todo items --- docs/conf.py | 4 ++-- docs/index.rst | 3 +++ docs/sysadmin.rst | 3 ++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 28c22e08..d320a3ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.graphviz"] +extensions = ["sphinx.ext.graphviz", "sphinx.ext.todo"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -124,7 +124,7 @@ pygments_style = 'sphinx' # keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +todo_include_todos = True # -- Options for HTML output ---------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index ad2d4a1b..68ac6832 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 Documentation License". +.. todolist:: + + .. toctree:: :maxdepth: 3 :caption: Table of Contents diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst index 3ae4dc9e..3c573998 100644 --- a/docs/sysadmin.rst +++ b/docs/sysadmin.rst @@ -26,4 +26,5 @@ please refer to the standard Debian documentation. ZFS ~~~ -TODO +.. todo:: Add local ZFS admin guide (local.zfs.adoc) +