delta/python-packages/sphinx-git.git/doc/development/tutorials/examples/recipe.py, branch 4.x

Update recipe.py

2022-01-14T08:58:54+00:00

address some unused loop control variables (B007)

2022-01-12T20:19:18+00:00

Fix #9525: tutorial: Wrong condition in recipe.py

2021-08-04T16:38:58+00:00

Fix #8860: doc: recipe directive crashes with AttributeError

2021-02-11T13:13:07+00:00

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 isort

2020-11-11T12:19:05+00:00

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.

docs: Remove unused imports

2019-02-25T11:03:59+00:00

These were causing flake8 failures.

Signed-off-by: Stephen Finucane

docs: Address further review comments

2019-02-18T13:46:30+00:00

todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane

docs: Address review comments

2019-02-14T10:31:45+00:00

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

doc: Add "recipe" tutorial

2019-02-09T17:58:30+00:00

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