Skip to content

Commit

Permalink
Restructure user guide with subsections (#2310)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>

* Update v0.11.3.rst

---------

Co-authored-by: Kevin Anderson <[email protected]>
  • Loading branch information
RDaxini and kandersolar authored Jan 28, 2025
1 parent d651362 commit 6355f0a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/sphinx/source/user_guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
.. _user_guide:

==========
User Guide
==========

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

.. toctree::
:caption: Getting started
:maxdepth: 2

package_overview
installation
introtutorial

.. toctree::
:caption: Modeling topics
:maxdepth: 2

pvsystem
modelchain
timetimezones
clearsky
bifacial
clearsky
weather_data
singlediode

.. toctree::
:caption: Extras
:maxdepth: 2

nomenclature
faq
1 change: 1 addition & 0 deletions docs/sphinx/source/whatsnew/v0.11.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Enhancements

Documentation
~~~~~~~~~~~~~
* Restructure the user guide with subsections (:issue:`2302`, :pull:`2310`)


Testing
Expand Down

0 comments on commit 6355f0a

Please sign in to comment.