| Commit message (Collapse) | Author | Age | Files | Lines | |
|---|---|---|---|---|---|
| * | doc: Upgrade docutils.sourceforge.io links to HTTPS | igo95862 | 2021-05-16 | 1 | -1/+1 |
| | | | | | | Also change any docutils.sourceforge.net link to io top level domain. | ||||
| * | Fix #8860: doc: Usage of recipe directive is wrong | Takeshi KOMIYA | 2021-02-12 | 1 | -3/+3 |
| | | |||||
| * | Fix #3106: domain: Register hyperlink target for index page automatically | Takeshi KOMIYA | 2020-02-22 | 1 | -0/+4 |
| | | |||||
| * | doc: Fix file inclusion in recipe tutorial has been broken | Takeshi KOMIYA | 2020-02-17 | 1 | -4/+9 |
| | | |||||
| * | docs: Address further review comments | Stephen Finucane | 2019-02-18 | 1 | -3/+3 |
| | | | | | | | | | | | todo: - Subclass SphinxDirective instead of Directive recipe: - Remove unnecessary '__init__' methods Signed-off-by: Stephen Finucane <stephen@that.guru> | ||||
| * | docs: Address review comments | Stephen Finucane | 2019-02-14 | 1 | -46/+39 |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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" tutorial | Stephen Finucane | 2019-02-09 | 1 | -0/+224 |
| 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> | |||||
