diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 95a43203..d2973a30 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -8,20 +8,24 @@ This project adheres to `Semantic Versioning `_. `v0.4.0-dev`_ (unreleased) ========================== +`v0.3.1`_ (2020-10-24) +========================== + Added ----- * The ``sphinx-c-apidoc`` command. This command provides users the ability to quickly build up a set of documentation files for a C directory. -* A - `compilation databases `_. - can now be specified with the ``c_autodoc_compilation_database`` configuration value. +* Support for compile flags via a + `compilation database `_. + A compilation database can now be specified with the + ``c_autodoc_compilation_database`` configuration value. Fixes ----- -* No longer passing `typedef` to autodocumentation of types. +* No longer passing `typedef` to auto documentation of types. Previously the `typedef` keyword was being provided to sphinx as part of the signature. This resulted in losing the ability to link to the type in html documentation. @@ -96,7 +100,8 @@ Fixes * Initial public release -.. _v0.4.0-dev: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.3.0...master +.. _v0.4.0-dev: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.3.1...master +.. _v0.3.1: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.3.0...v0.3.1 .. _v0.3.0: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.2.0...v0.3.0 .. _v0.2.0: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.1.1...v0.2.0 .. _v0.1.1: https://github.com/speedyleion/sphinx-c-autodoc/compare/v0.1.0...v0.1.1 diff --git a/docs/conf.py b/docs/conf.py index e1477b49..09064ec3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ # The short X.Y version version = u'0.3' # The full version, including alpha/beta/rc tags -release = u'0.3.0' +release = u'0.3.1' # -- General configuration --------------------------------------------------- diff --git a/setup.py b/setup.py index eaa4ef5f..20c836f5 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ setuptools.setup( name="sphinx-c-autodoc", - version="0.3.0", + version="0.3.1", description="A sphinx autodoc extension for c modules", long_description=README, long_description_content_type="text/x-rst", @@ -21,8 +21,9 @@ packages=setuptools.find_packages("src"), license="Unlicense", classifiers=[ - "Development Status :: 3 - Alpha", + "Development Status :: 4 - Beta", "Programming Language :: Python :: 3", + "Framework :: Sphinx :: Extension", "Operating System :: OS Independent", ], project_urls={