docs: Add test coverage information to documentation subfolder

acdh-oeaw · Jun 4, 2024 · f6767d4 · f6767d4
1 parent 6c3ff23
commit f6767d4
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 16 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -25,9 +25,13 @@ jobs:
      - name: Install documentation dependencies
        run: |
          pip install poetry
-         poetry install --with docs
+         poetry install --with docs --with tests
      - name: Build docs
        run: poetry run make -C "$GITHUB_WORKSPACE/docs" html
+     - name: Build coverage
+       run: |
+         poetry run coverage run --source="." manage.py test
+         poetry run coverage html
      - uses: actions/checkout@v3
        with:
          path: apis-core-rdf-pages
@@ -37,6 +41,8 @@ jobs:
          cd apis-core-rdf-pages
          git rm -rf *
          cp -r $GITHUB_WORKSPACE/docs/_build/html/* .
+         cp -r $GITHUB_WORKSPACE/htmlcov .
+         rm -f htmlcov/.gitignore
          touch .nojekyll
          git config user.name github-actions
          git config user.email github-actions@github.com

diff --git a/.gitignore b/.gitignore
@@ -23,5 +23,4 @@ dist
 build
 apis_core.egg-info
 
-
-
+.coverage
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -30,6 +30,7 @@ Welcome to APIS's documentation!
 
    genindex
    modindex
+   Coverage <https://acdh-oeaw.github.io/apis-core-rdf/htmlcov/>
 
 
 Indices and tables

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,7 @@ sphinx-rtd-theme = "*"
 optional = true
 [tool.poetry.group.tests.dependencies]
 faker = "*"
+coverage = "^7.5.3"
 
 [tool.poetry.group.dev]
 optional = true