WIP: Automatically generate API docs

.gitignore

@@ -4,3 +4,4 @@ example/test.ini
 metgenc.log
 output
 tmp
+docs/build

.readthedocs.yaml

@@ -10,4 +10,4 @@ python:
     - requirements: docs/requirements.txt
 
 sphinx:
-  configuration: docs/source/conf.py
+   configuration: docs/conf.py

docs/Makefile

@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -1,2 +1,3 @@
+myst-parser
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1

docs/source/api.rst

@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   nsidc

docs/source/conf.py

@@ -1,35 +1,46 @@
-# Configuration file for the Sphinx documentation builder.
+import sys
+from pathlib import Path
 
-# -- Project information
+sys.path.insert(0, str(Path('..', '..', 'src').resolve()))
 
-project = 'MetGenC'
-copyright = '2024, NSIDC'
-author = 'National Snow and Ice Data Center'
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-release = '0.6'
-version = '0.6.0'
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# -- General configuration
+project = 'MetGenC'
+copyright = '2024, NSIDC'
+author = 'NSIDC'
+release = 'v0.6'
 
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
 ]
 
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-}
-intersphinx_disabled_domains = ['std']
+exclude_patterns = [
+    "_build",
+    "**.ipynb_checkpoints",
+    "Thumbs.db",
+    ".DS_Store",
+    ".env",
+    ".venv",
+]
 
 templates_path = ['_templates']
 
-# -- Options for HTML output
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+always_document_param_types = True
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'classic'
 
-# -- Options for EPUB output
-epub_show_urls = 'footnote'
+html_static_path = ['_static']

docs/source/generated/nsidc.rst

@@ -0,0 +1,6 @@
+nsidc
+=====
+
+.. automodule:: nsidc
+
+

docs/source/index.rst

@@ -1,19 +1,6 @@
-Welcome to MetGenC's documentation!
-===================================
-
-**MetGenC** solves all your problems.
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
-
-.. note::
-
-   This project is under active development.
-
 Contents
 --------
 
 .. toctree::
 
-   usage
    api

docs/source/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   nsidc

docs/source/nsidc.metgen.rst

@@ -0,0 +1,61 @@
+nsidc.metgen package
+====================
+
+Submodules
+----------
+
+nsidc.metgen.aws module
+-----------------------
+
+.. automodule:: nsidc.metgen.aws
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nsidc.metgen.cli module
+-----------------------
+
+.. automodule:: nsidc.metgen.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nsidc.metgen.config module
+--------------------------
+
+.. automodule:: nsidc.metgen.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nsidc.metgen.constants module
+-----------------------------
+
+.. automodule:: nsidc.metgen.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nsidc.metgen.metgen module
+--------------------------
+
+.. automodule:: nsidc.metgen.metgen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nsidc.metgen.netcdf\_reader module
+----------------------------------
+
+.. automodule:: nsidc.metgen.netcdf_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: nsidc.metgen
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/nsidc.rst

@@ -0,0 +1,18 @@
+nsidc package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nsidc.metgen
+
+Module contents
+---------------
+
+.. automodule:: nsidc
+   :members:
+   :undoc-members:
+   :show-inheritance: