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
6 changes: 6 additions & 0 deletions docs/sphinx/source/reference/bifacial.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. py:module:: pvlib.bifacial.infinite_sheds
.. py:module:: pvlib.bifacial.pvfactors
.. py:module:: pvlib.bifacial.ants2d

.. currentmodule:: pvlib

Bifacial
Expand All @@ -20,6 +24,8 @@ Loss models that are specific to bifacial PV systems

bifacial.power_mismatch_deline

.. py:module:: pvlib.bifacial.utils

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This broke the entry at https://pvlib-python.readthedocs.io/en/latest/reference/bifacial.html (bottom). Add .. currentmodule:: pvlib just below or disregard that line. Just in case, setting currentmodule or py:module, indicates the namespace of the functions/entries relative to that namespace that will be documented in autosummaries. Therefore, the first entry in the following autosummary "bifacial.utils.vf_row_sky_2d" would now point to pvlib.bifacial.utils.bifacial.utils.vf_row_sky_2d.

There's a slight difference on currentmodule and py:module regarding defaults and global TOC IIRC: https://www.sphinx-doc.org/en/master/usage/domains/python.html

I'm not available for fast fixes this weekend.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, so none of the VF functions are included now. Ugh, I wish I had actually thought about what I was adding. Or checked the build log. Or waited a few more minutes so you had time to point out the error. 🤦

Anyway thanks @echedey-ls. I guess I will make a v0.16.1 release!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem from my side.

waited a few more minutes so you had time to point out the error

That's on me, I was doomscrolling instagram instead of GitHub :(


Utility functions for bifacial modeling

.. autosummary::
Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/source/reference/irradiance/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. py:module:: pvlib.irradiance

.. currentmodule:: pvlib

Irradiance
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/whatsnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ What's New

These are new features and improvements of note in each release.

.. include:: whatsnew/v0.15.3.rst
.. include:: whatsnew/v0.16.0.rst
.. include:: whatsnew/v0.15.2.rst
.. include:: whatsnew/v0.15.1.rst
.. include:: whatsnew/v0.15.0.rst
Expand Down
122 changes: 0 additions & 122 deletions docs/sphinx/source/whatsnew/v0.15.3.rst

This file was deleted.

Loading
Loading