IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix obsoleted documentation

Browse Source
This commit is contained in:
shimizukawa
2015-07-25 15:55:43 +02:00
parent 8600ffeda2
commit 468568bdcf
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ext/ifconfig.rst
View File

@@ -26,8 +26,8 @@ This extension is quite simple, and features only one directive:
:file:`conf.py`, e.g.:: :file:`conf.py`, e.g.::
def setup(app): def setup(app):
app.add_config_value('releaselevel', '', True) app.add_config_value('releaselevel', '', 'env')
The second argument is the default value, the third should always be ``True`` The second argument is the default value, the third should always be ``'env'``
for such values (it selects if Sphinx re-reads the documents if the value for such values (it selects if Sphinx re-reads the documents if the value
changes). changes).

4
doc/extdev/tutorial.rst
View File

@@ -149,7 +149,7 @@ The new elements are added in the extension's setup function. Let us create a
new Python module called :file:`todo.py` and add the setup function:: new Python module called :file:`todo.py` and add the setup function::
def setup(app): def setup(app):
app.add_config_value('todo_include_todos', False, False) app.add_config_value('todo_include_todos', False, 'html')
app.add_node(todolist) app.add_node(todolist)
app.add_node(todo, app.add_node(todo,
@@ -171,7 +171,7 @@ the individual calls do is the following:
new *config value* ``todo_include_todos``, whose default value should be new *config value* ``todo_include_todos``, whose default value should be
``False`` (this also tells Sphinx that it is a boolean value). ``False`` (this also tells Sphinx that it is a boolean value).
If the third argument was ``True``, all documents would be re-read if the If the third argument was ``'html'``, HTML documents would be full rebuild if the
config value changed its value. This is needed for config values that config value changed its value. This is needed for config values that
influence reading (build phase 1). influence reading (build phase 1).