diff options
author | Stephen Finucane <stephen@that.guru> | 2019-02-11 10:44:49 +0000 |
---|---|---|
committer | Stephen Finucane <stephen@that.guru> | 2019-02-14 10:31:45 +0000 |
commit | 5c061ff2665f7177b110416b49b5dd37aadeda5b (patch) | |
tree | b2ff367b0d33d08d96060e148816bf75da7175b3 /doc/development/tutorials/examples/todo.py | |
parent | b1ebdcd3c68cb3942ad407b39c994b3fa05ad257 (diff) | |
download | sphinx-git-5c061ff2665f7177b110416b49b5dd37aadeda5b.tar.gz |
docs: Address review comments
helloworld:
- Return version metadata from extension
- Use 'reST' instead of 'rST'
- Don't use single backticks
todo:
- Return version metadata from extension
- Link to events section of API guide, rather than entire document
- Include name of phases in when describing build phases
- Use more method cross-references where possible
- Fix typo in usage example
recipe:
- Return version metadata from extension
- Rework code to simplify things
- Remove docstrings from 'generate' functions, which are simply
duplicates of the original docstring
- Rename 'rcp' directive to 'recipe', the 'reref' role to 'ref', and a
whole lot of variables to something more grokable
- Fix typos in both documentation and code
I've also fixed up the docstrings for some of the 'domain' functions to
make them render a little nicer (they took me a while to figure out).
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'doc/development/tutorials/examples/todo.py')
-rw-r--r-- | doc/development/tutorials/examples/todo.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/development/tutorials/examples/todo.py b/doc/development/tutorials/examples/todo.py index bd50ba54a..d46f90821 100644 --- a/doc/development/tutorials/examples/todo.py +++ b/doc/development/tutorials/examples/todo.py @@ -117,4 +117,8 @@ def setup(app): app.connect('doctree-resolved', process_todo_nodes) app.connect('env-purge-doc', purge_todos) - return {'version': '0.1'} # identifies the version of our extension + return { + 'version': '0.1', + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } |