Commit Graph

71 Commits

Author SHA1 Message Date
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
8090e9040f Fix #7299: doc: Fix TODO tutorial 2020-03-15 18:33:41 +09:00
Takeshi KOMIYA
9db38aadfd Fix #3106: domain: Register hyperlink target for index page automatically 2020-02-22 18:20:12 +09:00
Takeshi KOMIYA
c97218cc97 doc: Fix file inclusion in recipe tutorial has been broken 2020-02-17 01:20:59 +09: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
c74296fa50 Fix #6405: docs: wrong link 2019-06-01 01:24:57 +09:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +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
b1ebdcd3c6 doc: Add "recipe" tutorial
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>
2019-02-09 17:58:30 +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
Stephen Finucane
7bce985ac9 docs: Rework the "helloworld" tutorial
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>
2019-02-09 17:58:30 +00:00
ArtFlag
17a15ef145 Fix build issues 2018-12-23 12:26:30 +01:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
ArtFlag
a85f8e2305 Minor changes in helloworld 2018-12-22 11:13:35 +01:00
ArtFlag
990b02b5fb Feedback 2018-12-19 17:35:17 +01:00
ArtFlag
870e2bbc1c move files to new directory 2018-12-19 17:35:17 +01:00