Organize iotools reference page by data provider
#2447
Conversation
| Commercial datasets | ||
| ------------------- | ||
|
|
||
|
|
||
| SolarAnywhere | ||
| ^^^^^^^^^^^^^ | ||
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
|
|
||
| iotools.get_solaranywhere | ||
| iotools.read_solaranywhere | ||
|
|
||
|
|
||
| Solcast | ||
| ^^^^^^^ | ||
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
|
|
||
| iotools.get_solcast_tmy | ||
| iotools.get_solcast_historic | ||
| iotools.get_solcast_forecast | ||
| iotools.get_solcast_live | ||
|
|
||
|
|
||
| Solargis | ||
| ^^^^^^^^ | ||
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
|
|
||
| iotools.get_solargis |
There was a problem hiding this comment.
Would there be any value in listing in alphabetical order within each category? Example below for Commercial datasets:
| Commercial datasets | |
| ------------------- | |
| SolarAnywhere | |
| ^^^^^^^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solaranywhere | |
| iotools.read_solaranywhere | |
| Solcast | |
| ^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solcast_tmy | |
| iotools.get_solcast_historic | |
| iotools.get_solcast_forecast | |
| iotools.get_solcast_live | |
| Solargis | |
| ^^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solargis | |
| Commercial datasets | |
| ------------------- | |
| SolarAnywhere | |
| ^^^^^^^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solaranywhere | |
| iotools.read_solaranywhere | |
| Solargis | |
| ^^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solargis | |
| Solcast | |
| ^^^^^^^ | |
| .. autosummary:: | |
| :toctree: generated/ | |
| iotools.get_solcast_tmy | |
| iotools.get_solcast_historic | |
| iotools.get_solcast_forecast | |
| iotools.get_solcast_live |
There was a problem hiding this comment.
I did struggle with choosing an ordering. For the free datasets, I ordered by what I guessed would be "most useful to the most users". I did not put any thought into the commercial dataset ordering.
Ordering by something easy and obvious would be nice. I'm open to switching to alphabetical (although it would be a shame to have to list the "not even solar resource" ACIS functions first...). I would like to hear from others on this point.
| @@ -11,21 +11,39 @@ IO Tools | |||
| Functions for retrieving, reading, and writing data from a variety | |||
| of sources and file formats relevant to solar energy modeling. | |||
|
|
|||
There was a problem hiding this comment.
| .. contents:: Currently supported APIs | |
| :depth: 3 | |
| :local: | |
Thinking out loud in case you find this relevant.
You may as well try with the default (empty) title.
https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
iotoolsreference page needs some organization #2446[ ] Tests added[ ] Updates entries indocs/sphinx/source/referencefor API changes.[ ] Adds description and name entries in the appropriate "what's new" file indocs/sphinx/source/whatsnewfor 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`).[ ] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.remote-data) and Milestone are assigned to the Pull Request and linked Issue.See #2446. Docs build link: https://pvlib-python--2447.org.readthedocs.build/en/2447/reference/iotools.html