Skip to content

Commit d62b9b1

Browse files
authored
Rearrange user guide files into subfolders (#2411)
* subfolders according to current subsections * index.rst file additions/modifications * edit maxdepth * userguide/index * Update index.rst * recover original rendering format * change max depth * Update index.rst * refer to subsecton index in main index * remove extra spaces * try hidden? * Revert "try hidden?" This reverts commit 3dc9819. * Revert "remove extra spaces" This reverts commit d57c391. * Revert "refer to subsecton index in main index" This reverts commit 6e62bd8. * remove spaces * match subsection order * more extra spaces * Revert "more extra spaces" This reverts commit 9764b08. * remove sublevel index.rst
1 parent a4e5017 commit d62b9b1

File tree

13 files changed

+18
-18
lines changed

13 files changed

+18
-18
lines changed

docs/sphinx/source/user_guide/installation.rst renamed to docs/sphinx/source/user_guide/getting_started/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Follow these steps to obtain the library using git/GitHub:
133133
This button is circled in the image below. Remember the system path that
134134
you clone the library to.
135135

136-
.. image:: ../_images/clonebutton.png
136+
.. image:: ../../_images/clonebutton.png
137137

138138
Please see GitHub's
139139
`Forking Projects <https://guides.github.com/activities/forking/>`_,

docs/sphinx/source/user_guide/index.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ This user guide is an overview and explains some of the key features of pvlib.
99
.. toctree::
1010
:caption: Getting started
1111
:maxdepth: 2
12-
13-
package_overview
14-
installation
15-
introtutorial
16-
12+
13+
getting_started/package_overview
14+
getting_started/installation
15+
getting_started/introtutorial
16+
1717
.. toctree::
18-
:caption: Modeling topics
1918
:maxdepth: 2
20-
21-
pvsystem
22-
modelchain
23-
timetimezones
24-
bifacial
25-
clearsky
26-
weather_data
27-
singlediode
19+
:caption: Modeling topics
20+
21+
modeling_topics/pvsystem
22+
modeling_topics/modelchain
23+
modeling_topics/timetimezones
24+
modeling_topics/bifacial
25+
modeling_topics/clearsky
26+
modeling_topics/weather_data
27+
modeling_topics/singlediode
2828

2929
.. toctree::
30-
:caption: Extras
3130
:maxdepth: 2
31+
:caption: Extras
3232

33-
nomenclature
34-
faq
33+
extras/nomenclature
34+
extras/faq

0 commit comments

Comments
 (0)