sdrobert · sdrobert · Dec 5, 2023 · Dec 5, 2023 · Dec 5, 2023 · Dec 5, 2023
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   builder: html
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## v0.4.1
 
+- Updated docs
 - Compatibility with param 2.0. Updated minimum version to 1.12
 - Made deserialization error messages more informative
 - Switched to GitHub workflows

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,4 +2,4 @@ Sphinx>=4.4
 sphinx-autodoc-typehints
 myst-parser
 param
-sphinx_rtd_theme>=0.5
+sphinx-rtd-theme>=0.5
diff --git a/docs/source/api/pydrobert/param.rst b/docs/source/api/pydrobert/param.rst
@@ -0,0 +1,8 @@
+pydrobert.param
+===============
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   param/*
diff --git a/docs/source/api/pydrobert/param/abc.rst b/docs/source/api/pydrobert/param/abc.rst
@@ -0,0 +1,7 @@
+abc
+===
+
+.. toctree::
+
+.. automodule:: pydrobert.param.abc
+    :members:
diff --git a/docs/source/api/pydrobert/param/argparse.rst b/docs/source/api/pydrobert/param/argparse.rst
@@ -0,0 +1,7 @@
+argparse
+========
+
+.. toctree::
+
+.. automodule:: pydrobert.param.argparse
+    :members:
diff --git a/docs/source/api/pydrobert/param/config.rst b/docs/source/api/pydrobert/param/config.rst
@@ -0,0 +1,7 @@
+config
+======
+
+.. toctree::
+
+.. automodule:: pydrobert.param.config
+    :members:
diff --git a/docs/source/api/pydrobert/param/optuna.rst b/docs/source/api/pydrobert/param/optuna.rst
@@ -0,0 +1,7 @@
+optuna
+======
+
+.. toctree::
+
+.. automodule:: pydrobert.param.optuna
+    :members:
diff --git a/docs/source/api/pydrobert/param/serialization.rst b/docs/source/api/pydrobert/param/serialization.rst
@@ -0,0 +1,7 @@
+serialization
+=============
+
+.. toctree::
+
+.. automodule:: pydrobert.param.serialization
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -2,17 +2,25 @@
    :parser: myst_parser.sphinx_
 
 .. toctree::
+   :glob:
+   :caption: Tutorials
+
+   tutorials/*
+
+.. toctree::
+   :caption: API
    :maxdepth: 2
-   :caption: Contents:
 
-   serialization
-   hyperopt
+   api/pydrobert/param
+
+.. toctree::
+   :caption: Other
+
    cli
-   modules
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
diff --git a/docs/source/pydrobert.param.abc.rst b/docs/source/pydrobert.param.abc.rst
diff --git a/docs/source/pydrobert.param.argparse.rst b/docs/source/pydrobert.param.argparse.rst
diff --git a/docs/source/pydrobert.param.config.rst b/docs/source/pydrobert.param.config.rst
diff --git a/docs/source/pydrobert.param.optuna.rst b/docs/source/pydrobert.param.optuna.rst
diff --git a/docs/source/pydrobert.param.serialization.rst b/docs/source/pydrobert.param.serialization.rst
diff --git a/docs/source/hyperopt.rst → docs/source/tutorials/hyperopt.rst b/docs/source/hyperopt.rst → docs/source/tutorials/hyperopt.rst
diff --git a/docs/source/serialization.rst → docs/source/tutorials/serialization.rst b/docs/source/serialization.rst → docs/source/tutorials/serialization.rst
diff --git a/environment.yaml b/environment.yaml
@@ -1,3 +1,5 @@
+# development environment
+
 name: pydrobert-param
 
 channels:
@@ -13,3 +15,8 @@ dependencies:
   - pandas
   - optuna
   - param
+  - sphinx
+  - myst-parser
+  - sphinx-autodoc-typehints
+  - sphinx_rtd_theme
+