summaryrefslogtreecommitdiff
path: root/doc/development/tutorials/examples
Commit message (Collapse)AuthorAgeFilesLines
* doc: Create autodoc extension tutorialigo958622021-03-091-0/+52
|
* Fix #8860: doc: recipe directive crashes with AttributeErrorTakeshi KOMIYA2021-02-111-1/+1
| | | | | | The pre check in the `ReceipeDirective.add_target_and_index() was wrong. It checkes non-existing option "noindex", but it should check "contains" option instead.
* Sort imports with isortFrançois Freitag2020-11-111-2/+1
| | | | | | | | | | | | Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
* Doc: Add missing 'env-merge-info' to the todo tutorial.Julien Palard2020-07-061-0/+8
|
* Fix #7299: doc: Fix TODO tutorialTakeshi KOMIYA2020-03-151-0/+3
|
* docs: Remove unused importsStephen Finucane2019-02-252-6/+2
| | | | | | These were causing flake8 failures. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Address further review commentsStephen Finucane2019-02-182-14/+8
| | | | | | | | | | 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-144-149/+102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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/+239
| | | | | | | | | | | | | 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>
* doc: Use 'literalinclude' directive for examplesStephen Finucane2019-02-092-0/+133
This avoid duplication and could conceivably let us test this stuff in code later on. Signed-off-by: Stephen Finucane <stephen@that.guru>
View Lorry Controller Status