Commit Graph

13 Commits

Author SHA1 Message Date
Adam Turner
7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
2023-04-06 23:11:39 +01:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS
Also change any docutils.sourceforge.net link to io
top level domain.
2021-05-16 15:53:49 +03:00
Julien Palard
418576ddd1 Doc: Add missing 'env-merge-info' to the todo tutorial. 2020-07-06 17:55:55 +02:00
Julien Palard
527a0361f1 FIX: Typo in tutorial/todo. 2020-06-30 17:13:19 +02:00
Takeshi KOMIYA
aafaa92237 doc: Use attention for notes about nodes in conf.py 2020-01-13 14:51:04 +09:00
Sviatoslav Sydorenko
842fbfa1e8
Warn about dangers of inheriting nodes in conf.py
Closes #6751
2019-10-22 14:54:57 +02:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09: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
Stephen Finucane
513d99c316 docs: Rework "todo" tutorial
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>
2019-02-09 17:58:30 +00:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
ArtFlag
870e2bbc1c move files to new directory 2018-12-19 17:35:17 +01:00