delta/python-packages/sphinx-git.git/doc/development, branch v2.3.1

Fix #6405: docs: wrong link

2019-05-31T16:24:57+00:00

doc: Fold lines by 80 columns

2019-05-29T16:07:05+00:00

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

doc: Use 'literalinclude' directive for examples

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

This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane

docs: Rework "todo" tutorial

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

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

docs: Rework the "helloworld" tutorial

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

Nothing to drastic going on here, but this format works better for other
tutorials we're adding.

Signed-off-by: Stephen Finucane

Fix build issues

2018-12-23T11:26:30+00:00