Mint v2.0.0a4

Author: robertodr

.gitignore

@@ -46,3 +46,5 @@ cmake/lib/*.pyc
 /GPATH
 /GRTAGS
 /GTAGS
+
+docs/changelog.md

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+## [Version 2.0.0a4] - 2020-02-02
+
 ### Fixed
 
 - The API function `xcfun_get` accepts a single in-out `double` parameter. It
@@ -10,7 +12,7 @@
 ## [Version 2.0.0a3] - 2020-01-31
 
 We have introduced a number of breaking changes, motivated by the need to
-modernize the library. See the [migration guide](docs/migration.rst).
+modernize the library. See the [migration guide](https://xcfun.readthedocs.io/en/latest/migration.html).
 
 ### Added
 
@@ -63,8 +65,9 @@ modernize the library. See the [migration guide](docs/migration.rst).
 - **BREAKING** The Fortran interface is no longer build with the code, but
   shipped as a separate file to be compiled within your own Fortran code.
 
-[Unreleased]: https://github.com/dftlibs/xcfun/compare/v2.0.0a3...HEAD
-[Version 2.0.0a2]: https://github.com/dftlibs/xcfun/compare/v2.0.0a2...v2.0.0a3
+[Unreleased]: https://github.com/dftlibs/xcfun/compare/v2.0.0a4...HEAD
+[Version 2.0.0a4]: https://github.com/dftlibs/xcfun/compare/v2.0.0a3...v2.0.0a4
+[Version 2.0.0a3]: https://github.com/dftlibs/xcfun/compare/v2.0.0a2...v2.0.0a3
 [Version 2.0.0a2]: https://github.com/dftlibs/xcfun/compare/v2.0.0a1...v2.0.0a2
 [Version 2.0.0a1]: https://github.com/dftlibs/xcfun/releases/tag/v2.0.0a1
 

Pipfile

@@ -17,3 +17,4 @@ pyyaml = "*"
 sphinx_rtd_theme = "*"
 flake8 = "*"
 yapf = "*"
+recommonmark = "*"

docs/building.rst

@@ -39,7 +39,8 @@ To compile the documentation:
 
 - `Doxygen <http://doxygen.nl/>`_
 - `Sphinx <https://www.sphinx-doc.org/en/master/index.html>`_
-- `Breathe <https://breathe.readthedocs.io>`_
+- The `Breathe <https://breathe.readthedocs.io>`_ Sphinx extension.
+- The ``recommonmark`` Sphinx extension.
 
 .. _confbuildtest:
 

docs/conf.py

@@ -32,7 +32,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.mathjax', 'breathe']
+extensions = ['sphinx.ext.mathjax', 'breathe', 'recommonmark']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -110,4 +110,9 @@ def run_doxygen(folder):
 
 
 def setup(app):
+    # symlink CHANGELOG.md
+    confpy = pathlib.Path(__file__)
+    changelog = confpy.parent / "changelog.md"
+    if not changelog.exists():
+        changelog.symlink_to(confpy.parents[1] / "CHANGELOG.md")
     run_doxygen('_build')

docs/index.rst

@@ -28,6 +28,7 @@ Contents:
    migration.rst
    api.rst
    functionals.rst
+   changelog.md
 
 Indices and tables
 ==================

docs/requirements.txt

@@ -1 +1,2 @@
 breathe
+recommonmark