DOC: added image to docs

Added the package logo to the documentation and changed the table of contents to show a pared down index.
pysat · Oct 24, 2023 · cc4c9ff · cc4c9ff
1 parent e0c274a
commit cc4c9ff
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -97,6 +97,9 @@
 # a list of builtin themes.
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = ["_themes", ]
+html_logo = os.path.join(os.path.abspath('.'), 'figures',
+                         'pysatSpaceWeather.png')
+html_theme_options = {'logo_only': True}
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,7 +9,7 @@ routines to load common historic, real-time, and forecasted space weather
 indices as pysat.Instrument objects.
 
 .. toctree::
-   :maxdepth: -1
+   :maxdepth: 2
 
    overview.rst
    installation.rst