Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
pvlib python pull request guidelines
====================================

Thank you for your contribution to pvlib python!

You may submit a pull request with your code at any stage of completion, however, before the code can be merged the following items must be addressed:

- [ ] Closes issue #xxxx
- [ ] Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests must pass on the TravisCI and Appveyor testing services.
- [ ] Code quality and style is sufficient. Passes ``git diff upstream/master -u -- "*.py" | flake8 --diff`` and/or landscape.io linting service.
- [ ] New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
- [ ] Updates entries to `docs/sphinx/source/api.rst` for API changes.
- [ ] Adds description and name entries in the appropriate `docs/sphinx/source/whatsnew` file for all changes.

Please don't hesitate to ask for help if you're unsure of how to accomplish any of the above. You may delete all of these instructions except for the list above.

Brief description of the problem and proposed solution (if not already fully described in the issue linked to above):
1 change: 1 addition & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ dependencies:
- hdf4=4.2.12
- sphinx_rtd_theme
- docutils
- nbsphinx
1 change: 1 addition & 0 deletions docs/sphinx/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ calculations.
:toctree: generated/

solarposition.solar_zenith_analytical
solarposition.solar_azimuth_analytical
solarposition.declination_spencer71
solarposition.declination_cooper69
solarposition.equation_of_time_spencer71
Expand Down
4 changes: 3 additions & 1 deletion docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ def __getattr__(cls, name):
'sphinx.ext.autosummary',
'IPython.sphinxext.ipython_directive',
'IPython.sphinxext.ipython_console_highlighting',
'nbsphinx'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -100,7 +101,7 @@ def __getattr__(cls, name):

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['whatsnew/*']
exclude_patterns = ['whatsnew/*', '**.ipynb_checkpoints']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down Expand Up @@ -316,3 +317,4 @@ def setup(app):
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
}

nbsphinx_allow_errors = True
1 change: 1 addition & 0 deletions docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Contents
whatsnew
installation
contributing
modelchain
timetimezones
clearsky
forecasts
Expand Down
Loading