Skip to content

Add Changelog to sphinx docs #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kandersolar merged 7 commits into from
Jan 31, 2020
Merged

Add Changelog to sphinx docs #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d7a3d40
add basic changelog files
kandersolar Jan 30, 2020
fde985a
change heading style
kandersolar Jan 30, 2020
9a307fe
test out extlinks
kandersolar Jan 30, 2020
a31689f
add sphinx.ext.extlinks to conf.py
kandersolar Jan 30, 2020
c0b06f0
test out function links
kandersolar Jan 30, 2020
1975e3b
module -> mod
kandersolar Jan 30, 2020
707274c
add api changes section to changelog
kandersolar Jan 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/sphinx/source/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
RdTools Change Log
==================

.. include:: changelog/v2.0.0.rst
30 changes: 30 additions & 0 deletions docs/sphinx/source/changelog/v2.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
------------
8 changes: 8 additions & 0 deletions docs/sphinx/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
# ones.
extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.extlinks',
'sphinx_rtd_theme',
'sphinx.ext.autosummary',
'm2r',
Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Documentation Contents

In-Depth Examples <example>
API Reference <api>
Change Log <changelog>

Indices and tables
==================
Expand Down