Skip to content

Commit cc660c5

Browse files
RDaxinikandersolar
authored and
Echedey Luis Álvarez
committed
Restructure user guide with subsections (pvlib#2310)
* initial creation * return glossary to user guide * revert learning page * add section label to index.rst * delete learning * Update index.rst * update extras maxdepth in index.rst * user guide label test * remove user guide label test (passed) * remove learning from index * change subsection title -> modeling topcis Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> * Update v0.11.3.rst --------- Co-authored-by: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>
1 parent 076572a commit cc660c5

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed
+16-2
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
1+
.. _user_guide:
2+
13
==========
24
User Guide
35
==========
46

7+
This user guide is an overview and explains some of the key features of pvlib.
58

69
.. toctree::
10+
:caption: Getting started
711
:maxdepth: 2
8-
12+
913
package_overview
1014
installation
1115
introtutorial
16+
17+
.. toctree::
18+
:caption: Modeling topics
19+
:maxdepth: 2
20+
1221
pvsystem
1322
modelchain
1423
timetimezones
15-
clearsky
1624
bifacial
25+
clearsky
1726
weather_data
1827
singlediode
28+
29+
.. toctree::
30+
:caption: Extras
31+
:maxdepth: 2
32+
1933
nomenclature
2034
faq

docs/sphinx/source/whatsnew/v0.11.3.rst

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Enhancements
1414

1515
Documentation
1616
~~~~~~~~~~~~~
17+
* Restructure the user guide with subsections (:issue:`2302`, :pull:`2310`)
1718

1819

1920
Testing

0 commit comments

Comments
 (0)