diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1608db0..3462a17 100644 --- a/.github/workflows/build.yml +++ b/.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 diff --git a/docs/documentation.md b/docs/documentation.md new file mode 100644 index 0000000..0403647 --- /dev/null +++ b/docs/documentation.md @@ -0,0 +1,7 @@ +::: gadopt.approximations + +::: gadopt.energy_solver + +::: gadopt.stokes_integrators + +::: gadopt.time_stepper diff --git a/mkdocs.yml b/mkdocs.yml index 4fb4590..a9389b5 100644 --- a/mkdocs.yml +++ b/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 diff --git a/requirements.txt b/requirements.txt index 4619ee2..a79a0c3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ mkdocs~=1.5.3 mkdocs-material~=9.5.8 +mkdocstrings[python]~=0.24.0