Skip to content

Commit

Permalink
Update version to 0.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
speedyleion committed Oct 25, 2020
1 parent d482df5 commit a429d09
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
15 changes: 10 additions & 5 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,24 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
`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 <https://clang.llvm.org/docs/JSONCompilationDatabase.html>`_.
can now be specified with the ``c_autodoc_compilation_database`` configuration value.
* Support for compile flags via a
`compilation database <https://clang.llvm.org/docs/JSONCompilationDatabase.html>`_.
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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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={
Expand Down

0 comments on commit a429d09

Please sign in to comment.