Add Sphinx extensions for autodoc summaries and section labeling; upd…

…ate installation instructions formatting
boyuan276 · Dec 13, 2024 · 64b008b · 64b008b
1 parent 5a909b2
commit 64b008b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 9 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,6 +29,8 @@
     'sphinx.ext.napoleon',    # Support for Google/NumPy style docstrings
     'sphinx.ext.viewcode',    # Add links to source code
     'sphinx_rtd_theme',       # ReadTheDocs theme
+    'sphinx.ext.autosummary', # Generate autodoc summaries
+    'sphinx.ext.autosectionlabel', # Automatically label each section
 ]
 
 templates_path = ['_templates']

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -49,11 +49,3 @@ See also
 --------
 
 - `MATLAB version of the NYgrid model <https://github.com/AndersonEnergyLab-Cornell/NYgrid.git>`_
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -5,7 +5,8 @@ Install using pip
 -----------------
 
 The ``nygrid`` package can be installed using pip::
-pip install nygrid
+
+       pip install nygrid
 
 Install from source
 -------------------