From d7a3d404e09fac80b0e7ca12a22913605518e5e6 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 20:42:18 -0700 Subject: [PATCH 1/7] add basic changelog files --- docs/sphinx/source/changelog.rst | 4 ++++ docs/sphinx/source/changelog/v2.0.0.rst | 26 +++++++++++++++++++++++++ docs/sphinx/source/index.rst | 1 + 3 files changed, 31 insertions(+) create mode 100644 docs/sphinx/source/changelog.rst create mode 100644 docs/sphinx/source/changelog/v2.0.0.rst 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..456e5cc4 --- /dev/null +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -0,0 +1,26 @@ + +v2.0.0 (MONTH DAY, YEAR) +------------------------ + +Enhancements +------------ +* Add new ``soiling`` module to implement the stochastic rate and recovery + method. +* Add new functions ``energy_from_power`` and ``interpolate`` to the + ``normalization`` module. + +Bug fixes +--------- + +Testing +------- + +Documentation +------------- +* Create sphinx documentation and set up ReadTheDocs. + +Requirements +------------ + +Contributors +------------ 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 ================== From fde985a6b5411ec0381ead5eb73740b89d4cbd78 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 20:48:45 -0700 Subject: [PATCH 2/7] change heading style --- docs/sphinx/source/changelog/v2.0.0.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index 456e5cc4..146779d4 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -1,6 +1,7 @@  +************************ v2.0.0 (MONTH DAY, YEAR) ------------------------- +************************ Enhancements ------------ From 9a307fee25018e45310b2147060e04d490a71515 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 21:04:21 -0700 Subject: [PATCH 3/7] test out extlinks --- docs/sphinx/source/changelog/v2.0.0.rst | 4 ++-- docs/sphinx/source/conf.py | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index 146779d4..925fcce9 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -6,7 +6,7 @@ v2.0.0 (MONTH DAY, YEAR) Enhancements ------------ * Add new ``soiling`` module to implement the stochastic rate and recovery - method. + method (:pull:`112`). * Add new functions ``energy_from_power`` and ``interpolate`` to the ``normalization`` module. @@ -18,7 +18,7 @@ Testing Documentation ------------- -* Create sphinx documentation and set up ReadTheDocs. +* Create sphinx documentation and set up ReadTheDocs (:pull:`125`). Requirements ------------ diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index bc82ce97..cba6b18b 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -56,6 +56,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 From a31689f27c24f2002fe3cdabc0bbdf4a5673d68c Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 21:11:46 -0700 Subject: [PATCH 4/7] add sphinx.ext.extlinks to conf.py --- docs/sphinx/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cba6b18b..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', From c0b06f0b4e90a973597fe4da8405f5cb607b5105 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 21:19:37 -0700 Subject: [PATCH 5/7] test out function links --- docs/sphinx/source/changelog/v2.0.0.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index 925fcce9..5e879625 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -5,10 +5,10 @@ v2.0.0 (MONTH DAY, YEAR) Enhancements ------------ -* Add new ``soiling`` module to implement the stochastic rate and recovery - method (:pull:`112`). -* Add new functions ``energy_from_power`` and ``interpolate`` to the - ``normalization`` module. +* Add new :py:module:`~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 --------- From 1975e3bac7c2b7fa29f2608ed07411aa0db459c4 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Jan 2020 21:24:04 -0700 Subject: [PATCH 6/7] module -> mod --- docs/sphinx/source/changelog/v2.0.0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index 5e879625..a00c22ce 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -5,7 +5,7 @@ v2.0.0 (MONTH DAY, YEAR) Enhancements ------------ -* Add new :py:module:`~rdtools.soiling` module to implement the stochastic rate and +* 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`. From 707274c58703644e1ed29a781e94fdd5bd75eebd Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 30 Jan 2020 14:58:22 -0700 Subject: [PATCH 7/7] add api changes section to changelog --- docs/sphinx/source/changelog/v2.0.0.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index a00c22ce..f268ba78 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -3,6 +3,9 @@ v2.0.0 (MONTH DAY, YEAR) ************************ +API Changes +----------- + Enhancements ------------ * Add new :py:mod:`~rdtools.soiling` module to implement the stochastic rate and