Commit Graph

12 Commits

Author SHA1 Message Date
Matthias Geier
13b0fcc532
DOC: Add env_version to "todo" tutorial (#12349) 2024-05-05 19:04:10 +02:00
Chris Sewell
d59b158371
👌 Make ExtensionMetadata type public and use it in internal extensions (#12153)
This type alias has now been fully documented for public consumption.

This will be beneficial to the sphinx ecosystem,
to aide/encourage extension developers to provide the correct metadata.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-21 16:19:26 +01:00
Chris Sewell
3bedde26a9
🔧 Ruff format python files within docs folder (#12139)
Remove `docs` files from the `exclude` list, and also add the `preview = false` format config, which is shown to reduce diffs to the current code base
2024-03-19 15:23:57 +01:00
Dimitri Papadopoulos Orfanos
4f08cdff13
Enable the FURB113 rule in Ruff (#11856)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: danieleades <33452915+danieleades@users.noreply.github.com>
2024-01-21 20:25:05 +00:00
Adam Turner
35ed39c946 Use Node.findall 2022-04-22 04:21:39 +01:00
Adam Turner
cbe0c99181 rawsource is deprecated in docutils.nodes.Text 2022-04-22 04:21:38 +01:00
Julien Palard
418576ddd1 Doc: Add missing 'env-merge-info' to the todo tutorial. 2020-07-06 17:55:55 +02:00
Takeshi KOMIYA
8090e9040f Fix #7299: doc: Fix TODO tutorial 2020-03-15 18:33:41 +09:00
Stephen Finucane
17596b5f3c docs: Remove unused imports
These were causing flake8 failures.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-25 11:03:59 +00:00
Stephen Finucane
a35040c454 docs: Address further review comments
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-18 13:46:30 +00:00
Stephen Finucane
5c061ff266 docs: Address review comments
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>
2019-02-14 10:31:45 +00:00
Stephen Finucane
93081e2fce doc: Use 'literalinclude' directive for examples
This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00