Skip to content

Restructure user guide with subsections #2310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 28, 2025
Merged

Restructure user guide with subsections #2310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
41673c9
initial creation
RDaxini Nov 26, 2024
af456a6
return glossary to user guide
RDaxini Nov 26, 2024
d360736
revert learning page
RDaxini Dec 23, 2024
c325fdd
add section label to index.rst
RDaxini Dec 23, 2024
eea1992
delete learning
RDaxini Dec 23, 2024
cd79f75
Update index.rst
RDaxini Dec 23, 2024
3f48b79
update extras maxdepth in index.rst
RDaxini Dec 23, 2024
bf15b74
user guide label test
RDaxini Dec 23, 2024
9a7aa0a
remove user guide label test (passed)
RDaxini Dec 23, 2024
c7a14a9
Merge remote-tracking branch 'upstream/main' into learning_page
RDaxini Dec 23, 2024
66ea0f4
remove learning from index
RDaxini Dec 23, 2024
c69344c
change subsection title -> modeling topcis
RDaxini Dec 24, 2024
56d9c96
Update v0.11.3.rst
RDaxini Dec 24, 2024
6e292b9
Merge branch 'main' into learning_page
RDaxini Jan 22, 2025
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
18 changes: 16 additions & 2 deletions docs/sphinx/source/user_guide/index.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading