summaryrefslogtreecommitdiff
path: root/doc/development/tutorials
Commit message (Collapse)AuthorAgeFilesLines
* Fix #7299: doc: Fix TODO tutorialTakeshi KOMIYA2020-03-151-0/+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
|
* doc: Use attention for notes about nodes in conf.pyTakeshi KOMIYA2020-01-131-1/+1
|
* Warn about dangers of inheriting nodes in conf.pySviatoslav Sydorenko2019-10-221-0/+14
| | | | Closes #6751
* Fix #6405: docs: wrong linkTakeshi KOMIYA2019-06-011-2/+2
|
* doc: Fold lines by 80 columnsTakeshi KOMIYA2019-05-301-2/+2
|
* 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-184-28/+25
| | | | | | | | | | 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-147-222/+174
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-093-0/+464
| | | | | | | | | | | | | 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-094-263/+171
| | | | | | | This avoid duplication and could conceivably let us test this stuff in code later on. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Rework "todo" tutorialStephen Finucane2019-02-091-98/+345
| | | | | | | Adopt the same format as was recently added in the "hello world" tutorial, making this more of a walkthrough as expected from tutorials. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Rework the "helloworld" tutorialStephen Finucane2019-02-091-76/+114
| | | | | | | Nothing to drastic going on here, but this format works better for other tutorials we're adding. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Fix build issuesArtFlag2018-12-231-2/+2
|
* Move content from the todo tutorial to the extdev/indexArtFlag2018-12-221-110/+10
|
* Minor changes in helloworldArtFlag2018-12-221-2/+2
|
* FeedbackArtFlag2018-12-191-15/+27
|
* move files to new directoryArtFlag2018-12-193-0/+560
View Lorry Controller Status