Use `todo` Sphinx directive more.
authorM. Eric Irrgang <ericirrgang@gmail.com>
Thu, 26 Dec 2019 15:45:59 +0000 (18:45 +0300)
committerEric Irrgang <ericirrgang@gmail.com>
Thu, 2 Jan 2020 13:53:14 +0000 (14:53 +0100)
commit6fba25686cbf0de7edea819e5028a9b959557a5d
tree244d0f96286f306f7dc745756cdc6e495b78961a
parent6dcb031248baf6e79499a028dbf658fbf8c9c5be
Use `todo` Sphinx directive more.

Start making "to do"s more actionable. Use the Sphinx `todo` directive
to allow special processing. For comment blocks that imply planned
activity, convert comment to `todo` directive for more easily discovered
and tracked doctree elements.

"To do" items should have a clear call to action and some follow through,
such as being prohibited in release branches or at least referring to
tracked issues, but that is beyond the scope of this change.
This change only seeks to make the mass of "to do"s more discoverable.

Change-Id: I8cbc06a5a1d78791bc6e9b0a2530632ad09a9380
16 files changed:
docs/dev-manual/build-system.rst
docs/dev-manual/jenkins.rst
docs/dev-manual/overview.rst
docs/dev-manual/style.rst
docs/dev-manual/tools.rst
docs/index.rst
docs/reference-manual/file-formats.rst
docs/reference-manual/index.rst
docs/reference-manual/preface.rst
docs/user-guide/environment-variables.rst
docs/user-guide/faq.rst
docs/user-guide/force-fields.rst
docs/user-guide/index.rst
docs/user-guide/mdp-options.rst
docs/user-guide/mdrun-performance.rst
docs/user-guide/run-time-errors.rst