Add Sphinx extensions for autodoc summaries and section labeling; update installation instructions formatting

boyuan276 · boyuan276 · commit 64b008b5475d · 2024-12-12T20:37:28.000-05:00
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
 -------------------

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@`
`29`	`29`	`'sphinx.ext.napoleon', # Support for Google/NumPy style docstrings`
`30`	`30`	`'sphinx.ext.viewcode', # Add links to source code`
`31`	`31`	`'sphinx_rtd_theme', # ReadTheDocs theme`
	`32`	`+ 'sphinx.ext.autosummary', # Generate autodoc summaries`
	`33`	`+ 'sphinx.ext.autosectionlabel', # Automatically label each section`
`32`	`34`	`]`
`33`	`35`
`34`	`36`	`templates_path = ['_templates']`