summaryrefslogtreecommitdiff
path: root/doc/development/tutorials
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-062-4/+5
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Fix COM812Adam Turner2023-02-182-3/+3
|
* Run pyupgrade (#11070)Adam Turner2023-01-021-1/+1
|
* Use PEP 604 typesAdam Turner2023-01-011-2/+2
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Copy edit the tutorial (#11049)mikemckiernan2022-12-291-6/+7
| | | | | | - Correct two typos. - Include the ingredient index in the "for example" statement. It's tedious, but the audience is reading to learn.
* Run the ``pyupgrade`` toolAdam Turner2022-10-171-2/+2
|
* Begin addding `flake8-simplify` checks (#10820)danieleades2022-09-201-2/+1
| | | | Start with SIM104 and ignore all other flake8-simplify warnings
* Update doc/development/tutorials/helloworld.rstAdam Turner2022-08-071-1/+1
|
* Fix small typo in extension hello world tutorialDavid Stansby2022-08-041-1/+1
|
* Fix flake8 5.0.0 reported formatting errorsdaniel.eades2022-08-011-1/+1
|
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-161-3/+1
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Use `Node.findall`Adam Turner2022-04-221-2/+2
|
* `rawsource` is deprecated in `docutils.nodes.Text`Adam Turner2022-04-221-2/+2
|
* Update recipe.pydanieleades2022-01-141-1/+1
|
* address some unused loop control variables (B007)Daniel Eades2022-01-121-1/+1
|
* doc: Improve autodoc extension exampleJouke Witteveen2021-12-061-5/+4
| | | Enumerations can have aliases, which should be documented as well.
* doc: Fix autodoc extension exampleJouke Witteveen2021-12-021-2/+5
| | | | | | `directivetype` is set to mimic `ClassDocumenter`. Reflect that. `isinstance` would work on the enum members, but that is not what we want here. `issubclass` raises a TypeError when called on objects that are not classes.
* Fix #9525: tutorial: Wrong condition in recipe.pyTakeshi KOMIYA2021-08-051-1/+1
|
* doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-163-7/+7
| | | | | Also change any docutils.sourceforge.net link to io top level domain.
* doc: Added reflink to autodoc tutorialigo958622021-03-091-0/+2
| | | | Used in add_autodocumenter docstring
* doc: Added autodoc extension tutorial to tutorials indexigo958622021-03-091-0/+2
|
* doc: Create autodoc extension tutorialigo958622021-03-092-0/+192
|
* Merge pull request #8873 from tk0miya/8860_bad_exampleTakeshi KOMIYA2021-02-131-3/+3
|\ | | | | Fix #8860: doc: Usage of recipe directive is wrong
| * Fix #8860: doc: Usage of recipe directive is wrongTakeshi KOMIYA2021-02-121-3/+3
| |
* | 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.
* moving extension dev overviewChris Holdgraf2020-07-292-36/+0
|
* rearranging a few docs and small updatesChris Holdgraf2020-07-294-336/+1
|
* Update doc/development/tutorials/builders.rstChris Holdgraf2020-07-291-1/+1
|
* flake8Chris Holdgraf2020-07-291-3/+3
|
* several documentation improvements to theming, templating, and extension ↵Chris Holdgraf2020-07-294-0/+374
| | | | development
* Doc: Add missing 'env-merge-info' to the todo tutorial.Julien Palard2020-07-062-5/+25
|
* FIX: Typo in tutorial/todo.Julien Palard2020-06-301-1/+1
|
* 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
|
View Lorry Controller Status