v1.0.0

CHANGELOG.rst

@@ -3,26 +3,30 @@ Changelog
 
 Versions follow `Semantic Versioning <https://semver.org/>`_ (``<major>.<minor>.<patch>``).
 
-vTBC
-----
+v1.0.0 (2019-04-24)
+-------------------
 
 Features
-~~~~~~~~
+^^^^^^^^
 
 * `#100 <https://github.com/rtfd/sphinx-autoapi/issues/100>`: (Python) Added support for documenting C extensions via ``.pyi`` stub files.
 * Added support for Sphinx 2.0.
 * Toned down the API reference index page.
 * (Go) Patterns configured in ``autoapi_ignore`` are passed to godocjson.
+* New and improved documentation.
+* No longer need to set ``autoapi_add_toctree_entry`` to False when ``autoapi_generate_api_docs`` is False.
+* `#139 <https://github.com/rtfd/sphinx-autoapi/issues/139>` Added support for basic type annotations in documentation generation and autodoc-style directives.
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * `#159 <https://github.com/rtfd/sphinx-autoapi/issues/159>`: (Python) Fixed ``UnicodeDecodeError`` on Python 2 when a documenting an attribute that contains binary data.
 * (Python) Fixed private submodules displaying when ``private-members`` is turned off.
 * Templates no longer produce excessive whitespace.
+* (Python) Fixed an error when giving an invalid object to an autodoc-style directive.
 
 Trivial/Internal Changes
-~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 * No longer pin the version of black.
 * Added missing test environments to travis.
@@ -32,7 +36,7 @@ v0.7.1 (2019-02-04)
 -------------------
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * (Python) Fixed a false warning when importing a local module.
 
@@ -41,17 +45,17 @@ v0.7.0 (2019-01-30)
 -------------------
 
 Breaking Changes
-~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^
 
 * Dropped support for Sphinx<1.6.
 
 Features
-~~~~~~~~
+^^^^^^^^
 
 * Added debug messages about what AutoAPI is doing.
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * `#156 <https://github.com/rtfd/sphinx-autoapi/issues/156>`: (Python) Made import resolution more stable.
 
@@ -59,7 +63,7 @@ Bug Fixes
 
 
 Trivial/Internal Changes
-~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 * Code is now formatted using black.
 * Removed references to old css and js files.
@@ -71,7 +75,7 @@ v0.6.2 (2018-11-15)
 -------------------
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * (Python) Fixed some import chains failing to resolve depending on resolution order.
 
@@ -80,7 +84,7 @@ v0.6.1 (2018-11-14)
 -------------------
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * (Python) Fixed unicode decoding on Python 3.7.
 * (Python) Fixed autodoc directives not documenting anything in submodules or subpackages.
@@ -89,7 +93,7 @@ Bug Fixes
 
 
 Trivial/Internal Changes
-~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 * (Python) Added Python 3.7 testing.
 * Started testing against stable version of Sphinx 1.8.
@@ -100,7 +104,7 @@ v0.6.0 (2018-08-20)
 -------------------
 
 Breaking Changes
-~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^
 
 * `#152 <https://github.com/rtfd/sphinx-autoapi/issues/152>`: Removed the ``autoapi_add_api_root_toctree`` option.
 
@@ -110,7 +114,7 @@ Breaking Changes
 * Removed redundant ``package_dir`` and ``package_data`` options.
 
 Features
-~~~~~~~~
+^^^^^^^^
 
 * (Python) Added viewcode support for imported members.
 * `#146 <https://github.com/rtfd/sphinx-autoapi/issues/146>`: (Python) No longer documents ``__init__()`` attributes without a docstring.
@@ -132,7 +136,7 @@ Features
 * (Python) Source files no longer need to be in ``sys.path``.
 
 Bug Fixes
-~~~~~~~~~
+^^^^^^^^^
 
 * (Python) Fixed linking to builtin bases.
 * (Python) Fixed properties being documented more than once when set in ``__init__()``.
@@ -144,7 +148,7 @@ Bug Fixes
 * `#125 <https://github.com/rtfd/sphinx-autoapi/issues/125>`: (Python) Support specifying package directories in ``autoapi_dirs``.
 
 Trivial/Internal Changes
-~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 * Added Sphinx 1.7 and 1.8.0b1 testing.
 * `#120 <https://github.com/rtfd/sphinx-autoapi/issues/120>`: Updated documentation to remove outdated references.

docs/conf.py

@@ -52,9 +52,9 @@ author = u'Read the Docs, Inc'
 # built documents.
 #
 # The short X.Y version.
-version = '0.7'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.7.1'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -5,7 +5,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='sphinx-autoapi',
-    version='0.7.1',
+    version='1.0.0',
     author='Eric Holscher',
     author_email='eric@ericholscher.com',
     url='http://github.com/rtfd/sphinx-autoapi',
@@ -17,6 +17,7 @@ setup(
     install_requires=[
         'astroid;python_version>="3"',
         'astroid<2;python_version<"3"',
+        'Jinja2',
         'PyYAML',
         'sphinx>=1.6',
         'sphinxcontrib-golangdomain',