summaryrefslogtreecommitdiff
path: root/doc/development/tutorials/todo.rst
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-061-1/+1
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-3/+3
| | | | | Also change any docutils.sourceforge.net link to io top level domain.
* Doc: Add missing 'env-merge-info' to the todo tutorial.Julien Palard2020-07-061-5/+17
|
* FIX: Typo in tutorial/todo.Julien Palard2020-06-301-1/+1
|
* 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
* doc: Fold lines by 80 columnsTakeshi KOMIYA2019-05-301-2/+2
|
* docs: Address further review commentsStephen Finucane2019-02-181-11/+14
| | | | | | | | | | 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-21/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Use 'literalinclude' directive for examplesStephen Finucane2019-02-091-236/+27
| | | | | | | 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>
* Move content from the todo tutorial to the extdev/indexArtFlag2018-12-221-110/+10
|
* move files to new directoryArtFlag2018-12-191-0/+399