Skip to content

Commit a794052

Browse files
committed
add initial api doc
1 parent df26efa commit a794052

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

docs/sphinx/source/api.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. currentmodule:: pvlib
2+
3+
#############
4+
API reference
5+
#############
6+
7+
8+
Classes
9+
=======
10+
11+
pvlib-python provides a collection of classes
12+
for users that prefer object-oriented programming.
13+
These classes can help users keep track of data in a more organized way,
14+
and can help to simplify the modeling process.
15+
The classes do not add any functionality beyond the procedural code.
16+
Most of the object methods are simple wrappers around the
17+
corresponding procedural code.
18+
19+
.. autosummary::
20+
:toctree: generated/
21+
22+
pvlib.location.Location
23+
pvlib.pvsystem.PVSystem
24+
pvlib.tracking.SingleAxisTracker
25+
pvlib.modelchain.ModelChain
26+
pvlib.pvsystem.LocalizedPVSystem
27+
pvlib.tracking.LocalizedSingleAxisTracker
28+
29+
30+
Solar Position
31+
==============
32+
33+
.. autosummary::
34+
:toctree: generated/
35+
36+
pvlib.location.Location.get_solarposition
37+
pvlib.solarposition

docs/sphinx/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ of:
6363
Specific released versions of pvlib-python can be cited using their
6464
`Zenodo DOI <https://zenodo.org/search?ln=en&p=pvlib&action_search=>`_.
6565

66+
modules
67+
classes
6668

6769
Contents
6870
========
@@ -77,8 +79,7 @@ Contents
7779
timetimezones
7880
clearsky
7981
forecasts
80-
modules
81-
classes
82+
api
8283
comparison_pvlib_matlab
8384
variables_style_rules
8485

0 commit comments

Comments
 (0)