Changelog
### 0.12
```
-----------------
- Fixed compatibility with Sphinx 2.0 and later. [86]
- Updated required version of Sphinx to 1.7 and later. [88]
```
### 0.11
```
-----------------
- Added a global configuration option ``automodapi_inheritance_diagram`` to
control whether inheritance diagrams are shown by default. [75]
- Fix bug with smart_resolver when intersphinx inventory doesn't include
any py:class entries. [76]
- Fixed compatibility with Sphinx 2.0 and later. [79]
```
### 0.10
```
-----------------
- Fixed compatibility with latest developer version of Sphinx. [61]
```
### 0.9
```
----------------
- Fix issue with ABC-derived classes (``abc`` and ``collections.abc`` modules)
having their members ignored in Python 3. This was only an issue when
``:inherited-members:`` was not in effect. [53]
```
### 0.8
```
----------------
- Fixed compatibility with Sphinx 1.8.x. [51]
- Make all extensions parallel-friendly. [44]
```
### 0.7
```
----------------
- Fix compatibility with Sphinx 1.7.x. [43]
```
### 0.6
```
----------------
- Fix encoding issues on platforms that default to e.g. ASCII encoding. [33]
```
### 0.5
```
----------------
- Fix a bug that caused the :inherited-members: option to apply to all subsequent
automodapi directives. [25]
```
### 0.4
```
----------------
- Fix compatibility with Sphinx 1.6 and 1.7. [22, 23]
- Introduce a new ``:include-all-objects:`` option to ``automodapi`` that will
include not just functions and classes in a module, but also all other
objects. To help this, introduce a new ``:variables-only:`` option for
``automodsumm``. [24]
```
### 0.3
```
----------------
- Fixed installation on Python 3.4. [21]
```
### 0.2
```
----------------
- Suppress warning about re-defining autoattribute in recent versions of
Sphinx. [8]
- Avoid hard-coding sphinx_automodapi module name in case this extension is
bundled into another package. [12]
- Fix use of automodapi when source files are inside a source directory. [16]
- Make sure generated rst is tidy and doesn't include extraneous whitespace. [18]
```
### 0.1
```
----------------
- Fixed a bug that caused the automodapi directive to not work properly when
the main module docstring was not included. [3]
- Fixed a bug that caused skipped classes in automodapi directives to still
be included in inheritance diagrams. [3]
- Original code taken out of astropy-helpers
```
Links
- PyPI: https://pypi.org/project/sphinx-automodapi
- Changelog: https://pyup.io/changelogs/sphinx-automodapi/
- Homepage: http://astropy.org
This PR pins sphinx-automodapi to the latest release 0.12.
Changelog
### 0.12 ``` ----------------- - Fixed compatibility with Sphinx 2.0 and later. [86] - Updated required version of Sphinx to 1.7 and later. [88] ``` ### 0.11 ``` ----------------- - Added a global configuration option ``automodapi_inheritance_diagram`` to control whether inheritance diagrams are shown by default. [75] - Fix bug with smart_resolver when intersphinx inventory doesn't include any py:class entries. [76] - Fixed compatibility with Sphinx 2.0 and later. [79] ``` ### 0.10 ``` ----------------- - Fixed compatibility with latest developer version of Sphinx. [61] ``` ### 0.9 ``` ---------------- - Fix issue with ABC-derived classes (``abc`` and ``collections.abc`` modules) having their members ignored in Python 3. This was only an issue when ``:inherited-members:`` was not in effect. [53] ``` ### 0.8 ``` ---------------- - Fixed compatibility with Sphinx 1.8.x. [51] - Make all extensions parallel-friendly. [44] ``` ### 0.7 ``` ---------------- - Fix compatibility with Sphinx 1.7.x. [43] ``` ### 0.6 ``` ---------------- - Fix encoding issues on platforms that default to e.g. ASCII encoding. [33] ``` ### 0.5 ``` ---------------- - Fix a bug that caused the :inherited-members: option to apply to all subsequent automodapi directives. [25] ``` ### 0.4 ``` ---------------- - Fix compatibility with Sphinx 1.6 and 1.7. [22, 23] - Introduce a new ``:include-all-objects:`` option to ``automodapi`` that will include not just functions and classes in a module, but also all other objects. To help this, introduce a new ``:variables-only:`` option for ``automodsumm``. [24] ``` ### 0.3 ``` ---------------- - Fixed installation on Python 3.4. [21] ``` ### 0.2 ``` ---------------- - Suppress warning about re-defining autoattribute in recent versions of Sphinx. [8] - Avoid hard-coding sphinx_automodapi module name in case this extension is bundled into another package. [12] - Fix use of automodapi when source files are inside a source directory. [16] - Make sure generated rst is tidy and doesn't include extraneous whitespace. [18] ``` ### 0.1 ``` ---------------- - Fixed a bug that caused the automodapi directive to not work properly when the main module docstring was not included. [3] - Fixed a bug that caused skipped classes in automodapi directives to still be included in inheritance diagrams. [3] - Original code taken out of astropy-helpers ```Links
- PyPI: https://pypi.org/project/sphinx-automodapi - Changelog: https://pyup.io/changelogs/sphinx-automodapi/ - Homepage: http://astropy.org