python - Sphinx todo box not showing -
in sphinx, can not make todo list show. here have:
.. todo:: blah blah blah
conf.py
extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', ]
i tried sphinx.ext.todo=true
in conf.py, syntax errors when make html
.
based on documentation have set todo_include_todos
in configuration.
http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
if syntax errors maybe try (as in note example linked docs above):
.. todo:: blah blah
edit:
it doesn't same in site because site has applied customed css that. looked @ sphinx source code , "pyramid" theme theme mentions todo styles, can see site mentioned uses default theme. site has it's own css file. should able add own css file "doc/source/_static" directory , add conf.py include it:
def setup(app): app.add_stylesheet('my_styles.css')
specifically notice section of css file div.admonition-todo
:
div.admonition-todo { border-top: 2px solid red; border-bottom: 2px solid red; border-left: 2px solid red; border-right: 2px solid red; background-color: #ff6347 }
Comments
Post a Comment