<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/sphinx-git.git/doc/usage, branch v1.8.4</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>Fix various spelling typos</title>
<updated>2018-12-27T12:06:33+00:00</updated>
<author>
<name>jfbu</name>
<email>jfbu@free.fr</email>
</author>
<published>2018-12-25T18:10:25+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=1e07cb10fc83b76dbffec89dac5f4a30a5e0b948'/>
<id>1e07cb10fc83b76dbffec89dac5f4a30a5e0b948</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>LaTeX: ``\sphinxmaketitle`` and optional ``\sphinxbackoftitlepage``</title>
<updated>2018-12-21T20:38:27+00:00</updated>
<author>
<name>jfbu</name>
<email>jfbu@free.fr</email>
</author>
<published>2018-12-21T20:38:27+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=1920d1d950fac28b26a8256e4b7b06e9c2ba6f11'/>
<id>1920d1d950fac28b26a8256e4b7b06e9c2ba6f11</id>
<content type='text'>
Closes: #5849
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Closes: #5849
</pre>
</div>
</content>
</entry>
<entry>
<title>doc: Add versionadded label (refs: #5029)</title>
<updated>2018-09-03T01:46:38+00:00</updated>
<author>
<name>Takeshi KOMIYA</name>
<email>i.tkomiya@gmail.com</email>
</author>
<published>2018-09-03T01:46:38+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=daac35cda71781059837ac63a2cc3c2cfe5990ee'/>
<id>daac35cda71781059837ac63a2cc3c2cfe5990ee</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix typo</title>
<updated>2018-08-22T02:08:33+00:00</updated>
<author>
<name>Takeshi KOMIYA</name>
<email>i.tkomiya@gmail.com</email>
</author>
<published>2018-08-22T02:08:33+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=472001eeb754a2389740115de53ae0c129a5eca0'/>
<id>472001eeb754a2389740115de53ae0c129a5eca0</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Merge pull request #5315 from tk0miya/add_autodoc_default_options</title>
<updated>2018-08-19T15:26:08+00:00</updated>
<author>
<name>Takeshi KOMIYA</name>
<email>i.tkomiya@gmail.com</email>
</author>
<published>2018-08-19T15:26:08+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=e3f383ad7ca279fa90d79dc46662fc4ce3749215'/>
<id>e3f383ad7ca279fa90d79dc46662fc4ce3749215</id>
<content type='text'>
Add autodoc_default_options</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Add autodoc_default_options</pre>
</div>
</content>
</entry>
<entry>
<title>Merge pull request #5297 from AWhetter/viewcode_follow_imported_event</title>
<updated>2018-08-19T14:45:09+00:00</updated>
<author>
<name>Takeshi KOMIYA</name>
<email>i.tkomiya@gmail.com</email>
</author>
<published>2018-08-19T14:45:09+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=17874a1a4bc61fc231905bb6984aacb9dc0458d4'/>
<id>17874a1a4bc61fc231905bb6984aacb9dc0458d4</id>
<content type='text'>
Plugins can resolve imported members for viewcode</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Plugins can resolve imported members for viewcode</pre>
</div>
</content>
</entry>
<entry>
<title>Add autodoc_default_options</title>
<updated>2018-08-18T09:22:16+00:00</updated>
<author>
<name>Takeshi KOMIYA</name>
<email>i.tkomiya@gmail.com</email>
</author>
<published>2018-08-18T08:40:38+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=3d9e2cf8312ed5d86a9838fe7b9485c09fd0a922'/>
<id>3d9e2cf8312ed5d86a9838fe7b9485c09fd0a922</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>C++, add support for overload-specific references.</title>
<updated>2018-08-18T06:27:23+00:00</updated>
<author>
<name>Jakob Lykke Andersen</name>
<email>Jakob@caput.dk</email>
</author>
<published>2018-08-14T21:54:50+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=1c035d72038f5429566feeda002d3cf05f8e9a54'/>
<id>1c035d72038f5429566feeda002d3cf05f8e9a54</id>
<content type='text'>
The "any" and "func" roles now accepts full function declarations.

Fixes #1552
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The "any" and "func" roles now accepts full function declarations.

Fixes #1552
</pre>
</div>
</content>
</entry>
<entry>
<title>autodoc: add 'exclude-members' to user global options</title>
<updated>2018-08-17T15:02:11+00:00</updated>
<author>
<name>Lewis Haley</name>
<email>lewis.haley@youview.com</email>
</author>
<published>2018-08-17T15:02:11+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=f196a92055df2ef7603ad777abfaa2989d4b6744'/>
<id>f196a92055df2ef7603ad777abfaa2989d4b6744</id>
<content type='text'>
As the previous commit explains, it is now possible to specify arguments
to the global options in config files. This means that we can now include
the `exclude-members` option in this global configuration.

Previously, there was no point including this option because it makes no
sense without arguments. Including this option means users have the
flexibility of explicitly including which special methods they want using
(e.g.):

  :special-members: __init__, __iter__

or explicitly excluding which special-members (or other members) they want
using (e.g.):

  :exclude-members: __weakref__, __hash__
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
As the previous commit explains, it is now possible to specify arguments
to the global options in config files. This means that we can now include
the `exclude-members` option in this global configuration.

Previously, there was no point including this option because it makes no
sense without arguments. Including this option means users have the
flexibility of explicitly including which special methods they want using
(e.g.):

  :special-members: __init__, __iter__

or explicitly excluding which special-members (or other members) they want
using (e.g.):

  :exclude-members: __weakref__, __hash__
</pre>
</div>
</content>
</entry>
<entry>
<title>autodoc: allow specifying values to global arguments</title>
<updated>2018-08-17T14:51:00+00:00</updated>
<author>
<name>Lewis Haley</name>
<email>lewis.haley@youview.com</email>
</author>
<published>2018-08-08T15:26:11+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=6e1e35c98ac29397d4552caf72710ccf4bf98bea'/>
<id>6e1e35c98ac29397d4552caf72710ccf4bf98bea</id>
<content type='text'>
Previously, users could specify a *list* of flags in their config files.
The flags were directive names that would otherwise be present in the
.rst files. However, as a list, it was not possible to specify values
to those flags, which *is* possible in .rst files.

For example, in .rst you could say

  :special-members: __init__, __iter__

And this would cause autodoc to generate documents for these methods that
it would otherwise ignore.

This commit changes the config option to instead accept a dictionary.
This is a dictionary whose keys can contain the same flag-names as before,
but whose values can contain the arguments as seen in .rst files.

The old list is still supported, for backwards compatibility, but the data
is transformed into a dictionary when the user's config is loaded.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Previously, users could specify a *list* of flags in their config files.
The flags were directive names that would otherwise be present in the
.rst files. However, as a list, it was not possible to specify values
to those flags, which *is* possible in .rst files.

For example, in .rst you could say

  :special-members: __init__, __iter__

And this would cause autodoc to generate documents for these methods that
it would otherwise ignore.

This commit changes the config option to instead accept a dictionary.
This is a dictionary whose keys can contain the same flag-names as before,
but whose values can contain the arguments as seen in .rst files.

The old list is still supported, for backwards compatibility, but the data
is transformed into a dictionary when the user's config is loaded.
</pre>
</div>
</content>
</entry>
</feed>
