Skip to content

Commit 8b1397b

Browse files
committed
Rename API reference file and update index navigation
1 parent fa350cd commit 8b1397b

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1+
#############
12
API reference
2-
-------------
3+
#############
34

45
.. automodule:: solarmach
5-
:no-index:
66
:members: backmapping, backmapping_angle, car2sto_sun, get_sw_speed, print_body_list, sc_distance, solar_diff_rot, sto2car_sun
77

88
.. autoclass:: solarmach.SolarMACH
9-
:no-index:
109
:members: plot, plot_3d, plot_pfss, plot_pfss_3d

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Solar MAgnetic Connection Haus (Solar-MACH) tool is a multi-spacecraft longi
2222

2323
installation
2424
usage
25-
solarmach
25+
api
2626

2727

2828
.. Indices and tables

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ipython
22
nbsphinx
33
nbsphinx_link
4-
# numpydoc
4+
numpydoc
55
solarmach
66
sphinx
77
sphinx-automodapi

0 commit comments

Comments
 (0)