Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
5 changes: 2 additions & 3 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
"use_edit_page_button": True,
"show_toc_level": 1,
"footer_items": ["copyright", "sphinx-version", "sidebar-ethical-ads"],
"left_sidebar_end": [],
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down Expand Up @@ -199,9 +200,7 @@
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
"**": ["search-field", "sidebar-nav-bs"] # "sidebar-ethical-ads"
}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
5 changes: 3 additions & 2 deletions docs/sphinx/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,14 @@ a timely manner is to:

#. Start by creating an issue. The issue should be well-defined and
actionable.
#. Ask the maintainers to tag the issue with the appropriate milestone.
#. Ask the [maintainers](https://github.com/orgs/pvlib/people) to tag
the issue with the appropriate milestone.
#. Make a limited-scope pull request. It can be a lot of work to check all of
the boxes in `pull request guidelines
<https://github.com/pvlib/pvlib-python/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_,
especially for pull requests with a lot of new primary code.
See :ref:`pull-request-scope`.
#. Tag pvlib community members or ``@pvlib/maintainer`` when the pull
#. Tag pvlib community members or ``@pvlib/pvlib-maintainer`` when the pull
request is ready for review. (see :ref:`pull-request-reviews`)


Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/irradiance.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@
"source": [
"See the online documentation for clear sky modeling examples.\n",
"\n",
"http://pvlib-python.readthedocs.io/en/latest/clearsky.html\n",
"http://pvlib-python.readthedocs.io/en/stable/user_guide/clearsky.html\n",
"\n",
"Here we only generate data for the functions below."
]
Expand Down
4 changes: 2 additions & 2 deletions pvlib/iotools/midc.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs):
{'Global Horizontal [W/m^2]': 'ghi'}

See the MIDC_VARIABLE_MAP for collection of mappings by site.
For a full list of pvlib variable names see the `Variable Style Rules
<https://pvlib-python.readthedocs.io/en/latest/variables_style_rules.html>`_.
For a full list of pvlib variable names see the
:ref:`variables_style_rules`.

Be sure to check the units for the variables you will use on the
`MIDC site <https://midcdmz.nrel.gov/>`_.
Expand Down
4 changes: 2 additions & 2 deletions pvlib/iotools/surfrad.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def read_surfrad(filename, map_variables=True):
Filepath or url.
map_variables: bool
When true, renames columns of the Dataframe to pvlib variable names
where applicable. See variable SURFRAD_COLUMNS.
where applicable. See variable :const:`VARIABLE_MAP`.

Returns
-------
Expand Down Expand Up @@ -113,7 +113,7 @@ def read_surfrad(filename, map_variables=True):
======================= ====== ==========================================

See README files located in the station directories in the SURFRAD
data archives[2]_ for details on SURFRAD daily data files.
data archives [2]_ for details on SURFRAD daily data files.

References
----------
Expand Down
3 changes: 1 addition & 2 deletions pvlib/modelchain.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,8 +382,7 @@ class ModelChain:
appropriate model parameters. For example, if ``dc_model='pvwatts'``,
then each ``Array.module_parameters`` must contain ``'pdc0'``.

See https://pvlib-python.readthedocs.io/en/stable/modelchain.html
for examples.
See :ref:`modelchaindoc` for examples.

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@
'pvfactors', 'siphon', 'statsmodels',
'cftime >= 1.1.1'],
'doc': ['ipython', 'matplotlib', 'sphinx == 3.1.2',
'pydata-sphinx-theme', 'sphinx-gallery', 'docutils == 0.15.2',
'pillow', 'netcdf4', 'siphon',
'pydata-sphinx-theme == 0.8.0', 'sphinx-gallery',
'docutils == 0.15.2', 'pillow', 'netcdf4', 'siphon',
'sphinx-toggleprompt >= 0.0.5'],
'test': TESTS_REQUIRE
}
Expand Down