diff --git a/docs/sphinx/source/changelog.rst b/docs/sphinx/source/changelog.rst new file mode 100644 index 00000000..5482c785 --- /dev/null +++ b/docs/sphinx/source/changelog.rst @@ -0,0 +1,4 @@ +RdTools Change Log +================== + +.. include:: changelog/v2.0.0.rst diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst new file mode 100644 index 00000000..f268ba78 --- /dev/null +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -0,0 +1,30 @@ + +************************ +v2.0.0 (MONTH DAY, YEAR) +************************ + +API Changes +----------- + +Enhancements +------------ +* Add new :py:mod:`~rdtools.soiling` module to implement the stochastic rate and + recovery method (:pull:`112`). +* Add new functions :py:func:`~rdtools.normalization.energy_from_power` and + :py:func:`~rdtools.normalization.interpolate`. + +Bug fixes +--------- + +Testing +------- + +Documentation +------------- +* Create sphinx documentation and set up ReadTheDocs (:pull:`125`). + +Requirements +------------ + +Contributors +------------ diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index bc82ce97..7037d373 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -36,6 +36,7 @@ # ones. extensions = [ 'sphinx.ext.napoleon', + 'sphinx.ext.extlinks', 'sphinx_rtd_theme', 'sphinx.ext.autosummary', 'm2r', @@ -56,6 +57,13 @@ source_suffix = ['.rst', '.md'] +# List of external link aliases. Allows use of :pull:`123` to autolink that PR +extlinks = { + 'issue': ('https://github.com/NREL/rdtools/issues/%s', 'GH #'), + 'pull': ('https://github.com/NREL/rdtools/pull/%s', 'GH #'), + 'ghuser': ('https://github.com/%s', '@') +} + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 83cb8918..ec25c619 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -22,6 +22,7 @@ Documentation Contents In-Depth Examples API Reference + Change Log Indices and tables ==================