Skip to content

Commit b1ef466

Browse files
authored
Add Changelog to sphinx docs (#134)
* add basic changelog files * change heading style * test out extlinks * add sphinx.ext.extlinks to conf.py * test out function links * module -> mod * add api changes section to changelog
1 parent 09aea55 commit b1ef466

File tree

4 files changed

+43
-0
lines changed

4 files changed

+43
-0
lines changed

docs/sphinx/source/changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
RdTools Change Log
2+
==================
3+
4+
.. include:: changelog/v2.0.0.rst
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
************************
3+
v2.0.0 (MONTH DAY, YEAR)
4+
************************
5+
6+
API Changes
7+
-----------
8+
9+
Enhancements
10+
------------
11+
* Add new :py:mod:`~rdtools.soiling` module to implement the stochastic rate and
12+
recovery method (:pull:`112`).
13+
* Add new functions :py:func:`~rdtools.normalization.energy_from_power` and
14+
:py:func:`~rdtools.normalization.interpolate`.
15+
16+
Bug fixes
17+
---------
18+
19+
Testing
20+
-------
21+
22+
Documentation
23+
-------------
24+
* Create sphinx documentation and set up ReadTheDocs (:pull:`125`).
25+
26+
Requirements
27+
------------
28+
29+
Contributors
30+
------------

docs/sphinx/source/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
# ones.
3737
extensions = [
3838
'sphinx.ext.napoleon',
39+
'sphinx.ext.extlinks',
3940
'sphinx_rtd_theme',
4041
'sphinx.ext.autosummary',
4142
'm2r',
@@ -56,6 +57,13 @@
5657

5758
source_suffix = ['.rst', '.md']
5859

60+
# List of external link aliases. Allows use of :pull:`123` to autolink that PR
61+
extlinks = {
62+
'issue': ('https://github.com/NREL/rdtools/issues/%s', 'GH #'),
63+
'pull': ('https://github.com/NREL/rdtools/pull/%s', 'GH #'),
64+
'ghuser': ('https://github.com/%s', '@')
65+
}
66+
5967
# -- Options for HTML output -------------------------------------------------
6068

6169
# The theme to use for HTML and HTML Help pages. See the documentation for

docs/sphinx/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Documentation Contents
2222

2323
In-Depth Examples <example>
2424
API Reference <api>
25+
Change Log <changelog>
2526

2627
Indices and tables
2728
==================

0 commit comments

Comments
 (0)