From 5c061ff2665f7177b110416b49b5dd37aadeda5b Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 11 Feb 2019 10:44:49 +0000 Subject: 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 --- doc/development/tutorials/examples/helloworld.py | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/development/tutorials/examples/helloworld.py') diff --git a/doc/development/tutorials/examples/helloworld.py b/doc/development/tutorials/examples/helloworld.py index 66ab3295d..d6d81fd4f 100644 --- a/doc/development/tutorials/examples/helloworld.py +++ b/doc/development/tutorials/examples/helloworld.py @@ -11,3 +11,9 @@ class HelloWorld(Directive): def setup(app): app.add_directive("helloworld", HelloWorld) + + return { + 'version': '0.1', + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } -- cgit v1.2.1