summaryrefslogtreecommitdiff
path: root/doc/development/tutorials/recipe.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-1/+1
| | | | | Also change any docutils.sourceforge.net link to io top level domain.
* Fix #8860: doc: Usage of recipe directive is wrongTakeshi KOMIYA2021-02-121-3/+3
|
* Fix #3106: domain: Register hyperlink target for index page automaticallyTakeshi KOMIYA2020-02-221-0/+4
|
* doc: Fix file inclusion in recipe tutorial has been brokenTakeshi KOMIYA2020-02-171-4/+9
|
* docs: Address further review commentsStephen Finucane2019-02-181-3/+3
| | | | | | | | | | todo: - Subclass SphinxDirective instead of Directive recipe: - Remove unnecessary '__init__' methods Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Address review commentsStephen Finucane2019-02-141-46/+39
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* doc: Add "recipe" tutorialStephen Finucane2019-02-091-0/+224
This is based on a post from opensource.com [1] and demonstrates how one can use indexes for cross-referencing and domains to group these indexes along with domains and roles. The source code was taken from [2] after getting the license changed [3]. [1] https://opensource.com/article/18/11/building-custom-workflows-sphinx [2] https://github.com/ofosos/sphinxrecipes [3] https://github.com/ofosos/sphinxrecipes/issues/1 Signed-off-by: Stephen Finucane <stephen@that.guru>