diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0b804e7a..b885d32c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,6 +12,11 @@ not on this list* - [ ] Closes #xxx - [ ] Added new API functions to `docs/api.rst` - [ ] Clearly documented all new API functions with [PEP257](https://www.python.org/dev/peps/pep-0257/) and [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant docstrings +- [ ] Adds description and name entries in the appropriate "what's new" file + in [`docs/whatsnew`](https://github.com/pvlib/pvanalytics/tree/master/docs/whatsnew) + for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` + or this Pull Request with `` :pull:`num` ``. Includes contributor name + and/or GitHub username (link with `` :ghuser:`user` ``). - [ ] Non-API functions clearly documented with docstrings or comments as necessary - [ ] Added tests to cover all new or modified code - [ ] Pull request is nearly complete and ready for detailed review diff --git a/docs/conf.py b/docs/conf.py index b39f9b61..cf873c03 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,8 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', - 'sphinx.ext.napoleon' + 'sphinx.ext.napoleon', + 'sphinx.ext.extlinks' ] autosummary_generate = True @@ -55,3 +56,17 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + +extlinks = { + 'issue': ( + 'https://github.com/pvlib/pvanalytics/issues/%s', + 'GH'), + 'pull': ( + 'https://github.com/pvlib/pvanalytics/pull/%s', + 'GH'), + 'wiki': ( + 'https://github.com/pvlib/pvanalytics/wiki/%s', + 'wiki '), + 'doi': ('http://dx.doi.org/%s', 'DOI: '), + 'ghuser': ('https://github.com/%s', '@') +} diff --git a/docs/index.rst b/docs/index.rst index 377b97a4..898fe943 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -91,6 +91,7 @@ Contents :caption: Contents: api + whatsnew/index Indices and tables ================== diff --git a/docs/whatsnew/0.1.0.rst b/docs/whatsnew/0.1.0.rst new file mode 100644 index 00000000..7b32c6f9 --- /dev/null +++ b/docs/whatsnew/0.1.0.rst @@ -0,0 +1,36 @@ +.. _whatsnew_010: + +0.1.0 (November 20, 2020) +------------------------- + +This is the first release of PVAnalytics. As such, the list of "changes" +below is not specific. Future releases will describe specific changes here along +with references to the relevant github issue and pull requests. + +API Changes +~~~~~~~~~~~ + +Enhancements +~~~~~~~~~~~~ + +* Quality control functions for irradiance, weather and time series data. See + :py:mod:`pvanalytics.quality` for content. +* Feature labeling functions for clipping, clearsky, daytime, and orientation. + See :py:mod:`pvanalytics.features` for content. +* System parameter inference for tilt, azimuth, and whether the system is + tracking or fixed. See :py:mod:`pvanalytics.system` for content. +* NREL performance ratio metric + (:py:func:`pvanalytics.metrics.performance_ratio_nrel`). + +Bug Fixes +~~~~~~~~~ + +Contributors +~~~~~~~~~~~~ + +* Will Vining (:ghuser:`wfvining`) +* Cliff Hansen (:ghuser:`cwhanse`) +* Saurabh Aneja (:ghuser:`spaneja`) + +Special thanks to Matt Muller and Kirsten Perry of NREL for their assistance +in adapting components from the PVFleets QA project to PVAnalytics. diff --git a/docs/whatsnew/index.rst b/docs/whatsnew/index.rst new file mode 100644 index 00000000..257f2b92 --- /dev/null +++ b/docs/whatsnew/index.rst @@ -0,0 +1,10 @@ +############# +Release Notes +############# + +These are the bug-fixes, new features, and improvements for each release. + +.. toctree:: + :maxdepth: 2 + + 0.1.0