Release preparation

CHANGELOG.rst

@@ -3,13 +3,20 @@ Changelog
 
 Versions follow `Semantic Versioning <https://semver.org/>`_ (``<major>.<minor>.<patch>``).
 
-TBC (TBC)
+V1.5.0 (2020-08-31)
 ---------
 
+This will be the last minor version to support Python 2 and Sphinx 1.x/2.x.
+
 Features
 ^^^^^^^^
 * `#222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`:
-  Declare the extension as parallel safe.
+  Declare the extension as parallel unsafe.
+* `#217 <https://github.com/readthedocs/sphinx-autoapi/issues/217>`:
+  All overload signatures are documented.
+* `#243 <https://github.com/readthedocs/sphinx-autoapi/issues/243>`:
+  Files are found in order of preference according to ``autoapi_file_patterns``.
+* Added support for Sphinx 3.2.
 
 Bug Fixes
 ^^^^^^^^^
@@ -17,6 +24,8 @@ Bug Fixes
   Fixed return types not showing for methods.
 * Fixed incorrect formatting of properties on generated method directives.
 * Fixed every toctree entry getting added as a new list.
+* `#234 <https://github.com/readthedocs/sphinx-autoapi/issues/234>`:
+  Fixed only some entries getting added to the toctree.
 
 Trivial/Internal Changes
 ^^^^^^^^^^^^^^^^^^^^^^^^

autoapi/_version.py

@@ -1,2 +1,2 @@
-__version_info__ = (1, 4, 0)
+__version_info__ = (1, 5, 0)
 __version__ = ".".join(str(x) for x in __version_info__)

autoapi/extension.py

@@ -320,6 +320,6 @@ def setup(app):
     app.add_directive("autoapi-inheritance-diagram", AutoapiInheritanceDiagram)
 
     return {
-        "parallel_read_safe": True,
+        "parallel_read_safe": False,
         "parallel_write_safe": True,
     }

tests/python/py3example/conf.py

@@ -18,4 +18,13 @@ htmlhelp_basename = "pyexampledoc"
 extensions = ["sphinx.ext.autodoc", "autoapi.extension"]
 autoapi_type = "python"
 autoapi_dirs = ["example"]
-autoapi_file_pattern = "*.py"
+autoapi_python_class_content = "both"
+autoapi_options = [
+        'members',
+        'undoc-members',  # this is temporary until we add docstrings across the codebase
+        'show-inheritance',
+        'show-module-summary',
+        'special-members',
+        'imported-members',
+        'inherited-members',
+]

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py{27,36,37}-sphinx{16,17,18},py{36,37,38}-sphinx{20,21,22,23,24,30,31}
+    py{27,36,37}-sphinx{16,17,18},py{36,37,38}-sphinx{20,21,22,23,24,30,31,32}
     formatting
     lint
     docs
@@ -33,6 +33,7 @@ deps = -r{toxinidir}/requirements.txt
     sphinx24: Sphinx<2.5
     sphinx30: Sphinx<3.1
     sphinx31: Sphinx<3.2
+    sphinx32: Sphinx<3.3
 commands =
     py.test {posargs}