commit 58c46c5bbe74ca6f72b68be533558f38b72997c2
Author: Isis Lovecruft <isis(a)torproject.org>
Date: Sun Dec 1 23:01:31 2013 +0000
Remove the TODO header in doc builds for index.rst.
The sphinx.ext.todo seem not to be working…
It is supposed to work, I believe, by putting the following into a
docstring:
class Foo(object):
"""A foo.
.. todo:: Do something about bar.
"""
And then the `.. todolist::` directive in Sphinx will find all such
`.. todo::` directives in your code, and put them in a list (the way I
was doing it, these would be on the index.html page) with links to where
the `.. todo::` is in the source code.
However, this seems to *only* work in docstrings proper in Python, the
following do *not* get picked up by the `.. todolist::` Sphinx
directive:
* Normal Python inline comments, i.e.:
# .. todo:: There is this thing we should do.
* Sphinx attribute inline comments, i.e.:
#: .. todo:: There is also another thing we should do.
Because all of the TODOs in BridgeDB are currently within normal Python
inline comments, the `.. todolist::` on the index page doesn't include
anything, and thus there is an awkward looking, giant, blank header with
nothing underneath it. Thus, I'm taking out the header, but leaving in
the `.. todolist::` directive (so that we *can* use `.. todo::` in a
proper docstring in the future and it will be automatically included in
the documentation here).
---
doc/sphinx/source/index.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/sphinx/source/index.rst b/doc/sphinx/source/index.rst
index 37963b8..3c4b5d9 100644
--- a/doc/sphinx/source/index.rst
+++ b/doc/sphinx/source/index.rst
@@ -13,6 +13,9 @@ Contents:
bridgedb
+Todo List
+=========
+
.. todolist::
Indices and tables