pmlmodelling · jimc101 · Jun 27, 2026 · Jun 25, 2026 · Jun 25, 2026 · Jun 25, 2026
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,39 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+      - 39-read-the-docs
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  sphinx:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: doc/requirements.txt
+
+      - name: Install Pandoc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+
+      - name: Install documentation dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r doc/requirements.txt
+
+      - name: Build documentation
+        run: |
+          python -m sphinx -W -b html doc/source doc/build/html
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -5,9 +5,11 @@ version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.12"
+  apt_packages:
+    - pandoc
 
 # Build documentation in the "doc/" directory with Sphinx
 sphinx:
@@ -22,10 +24,5 @@ formats:
 # Python requirements for building documentation
 python:
   install:
-    # Install the package itself
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
     # Install additional requirements for building docs
-    - requirements: doc/requirements.txt
+    - requirements: doc/requirements.txt
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # PyFVCOM2
 
+[![Documentation Status](https://readthedocs.org/projects/pyfvcom2/badge/?version=latest)](https://pyfvcom2.readthedocs.io/en/latest/?badge=latest)
+
 A Python package for processing FVCOM (Finite Volume Community Ocean Model) data.
 
 ## Description

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -4,11 +4,12 @@
 # Core Sphinx packages
 sphinx>=3.0
 sphinx_rtd_theme>=0.5
+myst-parser
 
 # Sphinx extensions used in conf.py
+sphinx-autodoc2
 sphinx-copybutton
 nbsphinx
-sphinxext-opengraph
 
 # Scientific documentation extensions
 numpydoc
@@ -26,4 +27,4 @@ netcdf4>=1.5.0
 xarray>=0.16.0
 
 # For any plots or examples in documentation
-matplotlib>=3.3.0
+matplotlib>=3.3.0
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -1,12 +1,9 @@
 .. _api:
 
-API
-===
-
-For PyLag's API documentation, please refer to the following sections:
+API Reference
+=============
 
 .. toctree::
-   :maxdepth: 1
-   :caption: API Reference
+   :maxdepth: 4
 
-   apidocs/index
+   api/modules
diff --git a/doc/source/api/modules.rst b/doc/source/api/modules.rst
@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   pyfvcom2
diff --git a/doc/source/api/pyfvcom2.bathy_smoother.rst b/doc/source/api/pyfvcom2.bathy_smoother.rst
@@ -0,0 +1,7 @@
+pyfvcom2.bathy\_smoother module
+===============================
+
+.. automodule:: pyfvcom2.bathy_smoother
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.cmems_reader.rst b/doc/source/api/pyfvcom2.cmems_reader.rst
@@ -0,0 +1,7 @@
+pyfvcom2.cmems\_reader module
+=============================
+
+.. automodule:: pyfvcom2.cmems_reader
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.coordinates.rst b/doc/source/api/pyfvcom2.coordinates.rst
@@ -0,0 +1,7 @@
+pyfvcom2.coordinates module
+===========================
+
+.. automodule:: pyfvcom2.coordinates
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.date_utils.rst b/doc/source/api/pyfvcom2.date_utils.rst
@@ -0,0 +1,7 @@
+pyfvcom2.date\_utils module
+===========================
+
+.. automodule:: pyfvcom2.date_utils
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.exceptions.rst b/doc/source/api/pyfvcom2.exceptions.rst
@@ -0,0 +1,7 @@
+pyfvcom2.exceptions module
+==========================
+
+.. automodule:: pyfvcom2.exceptions
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.file_utils.rst b/doc/source/api/pyfvcom2.file_utils.rst
@@ -0,0 +1,7 @@
+pyfvcom2.file\_utils module
+===========================
+
+.. automodule:: pyfvcom2.file_utils
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.fvcom_reader.rst b/doc/source/api/pyfvcom2.fvcom_reader.rst
@@ -0,0 +1,7 @@
+pyfvcom2.fvcom\_reader module
+=============================
+
+.. automodule:: pyfvcom2.fvcom_reader
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.fvcom_writer.rst b/doc/source/api/pyfvcom2.fvcom_writer.rst
@@ -0,0 +1,7 @@
+pyfvcom2.fvcom\_writer module
+=============================
+
+.. automodule:: pyfvcom2.fvcom_writer
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.grid.rst b/doc/source/api/pyfvcom2.grid.rst
@@ -0,0 +1,7 @@
+pyfvcom2.grid module
+====================
+
+.. automodule:: pyfvcom2.grid
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.grid_builder.rst b/doc/source/api/pyfvcom2.grid_builder.rst
@@ -0,0 +1,7 @@
+pyfvcom2.grid\_builder module
+=============================
+
+.. automodule:: pyfvcom2.grid_builder
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.interpolation.rst b/doc/source/api/pyfvcom2.interpolation.rst
@@ -0,0 +1,7 @@
+pyfvcom2.interpolation module
+=============================
+
+.. automodule:: pyfvcom2.interpolation
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.interpolation_coordinates.rst b/doc/source/api/pyfvcom2.interpolation_coordinates.rst
@@ -0,0 +1,7 @@
+pyfvcom2.interpolation\_coordinates module
+==========================================
+
+.. automodule:: pyfvcom2.interpolation_coordinates
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.lanczos.rst b/doc/source/api/pyfvcom2.lanczos.rst
@@ -0,0 +1,7 @@
+pyfvcom2.lanczos module
+=======================
+
+.. automodule:: pyfvcom2.lanczos
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.mesh_reader.rst b/doc/source/api/pyfvcom2.mesh_reader.rst
@@ -0,0 +1,7 @@
+pyfvcom2.mesh\_reader module
+============================
+
+.. automodule:: pyfvcom2.mesh_reader
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.namelist.rst b/doc/source/api/pyfvcom2.namelist.rst
@@ -0,0 +1,7 @@
+pyfvcom2.namelist module
+========================
+
+.. automodule:: pyfvcom2.namelist
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.nest.rst b/doc/source/api/pyfvcom2.nest.rst
@@ -0,0 +1,7 @@
+pyfvcom2.nest module
+====================
+
+.. automodule:: pyfvcom2.nest
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.obc.rst b/doc/source/api/pyfvcom2.obc.rst
@@ -0,0 +1,7 @@
+pyfvcom2.obc module
+===================
+
+.. automodule:: pyfvcom2.obc
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.ocean.rst b/doc/source/api/pyfvcom2.ocean.rst
@@ -0,0 +1,7 @@
+pyfvcom2.ocean module
+=====================
+
+.. automodule:: pyfvcom2.ocean
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.plotting.plot.rst b/doc/source/api/pyfvcom2.plotting.plot.rst
@@ -0,0 +1,7 @@
+pyfvcom2.plotting.plot module
+=============================
+
+.. automodule:: pyfvcom2.plotting.plot
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.plotting.rst b/doc/source/api/pyfvcom2.plotting.rst
@@ -0,0 +1,18 @@
+pyfvcom2.plotting package
+=========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyfvcom2.plotting.plot
+
+Module contents
+---------------
+
+.. automodule:: pyfvcom2.plotting
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.restart.rst b/doc/source/api/pyfvcom2.restart.rst
@@ -0,0 +1,7 @@
+pyfvcom2.restart module
+=======================
+
+.. automodule:: pyfvcom2.restart
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.rst b/doc/source/api/pyfvcom2.rst
@@ -0,0 +1,49 @@
+pyfvcom2 package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyfvcom2.plotting
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyfvcom2.bathy_smoother
+   pyfvcom2.cmems_reader
+   pyfvcom2.coordinates
+   pyfvcom2.date_utils
+   pyfvcom2.exceptions
+   pyfvcom2.file_utils
+   pyfvcom2.fvcom_reader
+   pyfvcom2.fvcom_writer
+   pyfvcom2.grid
+   pyfvcom2.grid_builder
+   pyfvcom2.interpolation
+   pyfvcom2.interpolation_coordinates
+   pyfvcom2.lanczos
+   pyfvcom2.mesh_reader
+   pyfvcom2.namelist
+   pyfvcom2.nest
+   pyfvcom2.obc
+   pyfvcom2.ocean
+   pyfvcom2.restart
+   pyfvcom2.sigma
+   pyfvcom2.tide
+   pyfvcom2.tide_reader
+   pyfvcom2.weights_calculator
+
+Module contents
+---------------
+
+.. automodule:: pyfvcom2
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
diff --git a/doc/source/api/pyfvcom2.sigma.rst b/doc/source/api/pyfvcom2.sigma.rst
@@ -0,0 +1,7 @@
+pyfvcom2.sigma module
+=====================
+
+.. automodule:: pyfvcom2.sigma
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.tide.rst b/doc/source/api/pyfvcom2.tide.rst
@@ -0,0 +1,7 @@
+pyfvcom2.tide module
+====================
+
+.. automodule:: pyfvcom2.tide
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.tide_reader.rst b/doc/source/api/pyfvcom2.tide_reader.rst
@@ -0,0 +1,7 @@
+pyfvcom2.tide\_reader module
+============================
+
+.. automodule:: pyfvcom2.tide_reader
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/api/pyfvcom2.weights_calculator.rst b/doc/source/api/pyfvcom2.weights_calculator.rst
@@ -0,0 +1,7 @@
+pyfvcom2.weights\_calculator module
+===================================
+
+.. automodule:: pyfvcom2.weights_calculator
+   :members:
+   :show-inheritance:
+   :undoc-members: