Start automatic API documentation generation

.github/workflows/build.yml

@@ -23,6 +23,11 @@ jobs:
       - name: Install Python dependencies
         run: |
           pip install -r requirements.txt
+      - name: Clone G-ADOPT for API documentation
+        uses: actions/checkout@v4
+        with:
+          repository: g-adopt/g-adopt
+          path: g-adopt
       - name: Build site
         run: |
           mkdocs build --clean

docs/documentation.md

@@ -0,0 +1,7 @@
+::: gadopt.approximations
+
+::: gadopt.energy_solver
+
+::: gadopt.stokes_integrators
+
+::: gadopt.time_stepper

mkdocs.yml

@@ -6,6 +6,16 @@ theme:
   name: material
   icon:
     repo: fontawesome/brands/github
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [g-adopt]
+          options:
+            show_root_heading: true
+            show_root_full_path: false
+            docstring_style: google
+            merge_init_into_class: true
 nav:
   - Home: index.md
   - Install: install.md

requirements.txt

@@ -1,2 +1,3 @@
 mkdocs~=1.5.3
 mkdocs-material~=9.5.8
+mkdocstrings[python]~=0.24.0