<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/sphinx-git.git/doc/development/tutorials/examples, branch v2.4.3</title>
<subtitle>github.com: sphinx-doc/sphinx.git
</subtitle>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/'/>
<entry>
<title>docs: Remove unused imports</title>
<updated>2019-02-25T11:03:59+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>stephen@that.guru</email>
</author>
<published>2019-02-25T11:02:24+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=17596b5f3c3cb0b58107af1d426accaf29c7e519'/>
<id>17596b5f3c3cb0b58107af1d426accaf29c7e519</id>
<content type='text'>
These were causing flake8 failures.

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
These were causing flake8 failures.

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>docs: Address further review comments</title>
<updated>2019-02-18T13:46:30+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>stephen@that.guru</email>
</author>
<published>2019-02-18T13:38:42+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=a35040c454aeeb87b3e5681360f1a7b54811cd62'/>
<id>a35040c454aeeb87b3e5681360f1a7b54811cd62</id>
<content type='text'>
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>docs: Address review comments</title>
<updated>2019-02-14T10:31:45+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>stephen@that.guru</email>
</author>
<published>2019-02-11T10:44:49+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=5c061ff2665f7177b110416b49b5dd37aadeda5b'/>
<id>5c061ff2665f7177b110416b49b5dd37aadeda5b</id>
<content type='text'>
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 &lt;stephen@that.guru&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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 &lt;stephen@that.guru&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>doc: Add "recipe" tutorial</title>
<updated>2019-02-09T17:58:30+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>stephen@that.guru</email>
</author>
<published>2019-02-08T17:47:19+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=b1ebdcd3c68cb3942ad407b39c994b3fa05ad257'/>
<id>b1ebdcd3c68cb3942ad407b39c994b3fa05ad257</id>
<content type='text'>
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 &lt;stephen@that.guru&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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 &lt;stephen@that.guru&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>doc: Use 'literalinclude' directive for examples</title>
<updated>2019-02-09T17:58:30+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>stephen@that.guru</email>
</author>
<published>2019-02-08T17:03:09+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=93081e2fce3a7795ddbc23fb4f1df9224f17d3fc'/>
<id>93081e2fce3a7795ddbc23fb4f1df9224f17d3fc</id>
<content type='text'>
This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This avoid duplication and could conceivably let us test this stuff in
code later on.

Signed-off-by: Stephen Finucane &lt;stephen@that.guru&gt;
</pre>
</div>
</content>
</entry>
</feed>
