From b70d7a68fe3257d4f5b219c8c6da4f69dc416968 Mon Sep 17 00:00:00 2001 From: "Jason M. Gates" Date: Wed, 17 Jan 2024 08:21:47 -0700 Subject: [PATCH] docs: Add coverage job steps Add steps to the CI job to compute the documentation coverage for the package and archive the results. --- .github/workflows/continuous-integration.yml | 10 ++++++++++ doc/source/conf.py | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index c1d67fa..2683718 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -50,6 +50,16 @@ jobs: run: make spelling working-directory: ./doc + - name: Check documentation coverage + run: make coverage + working-directory: ./doc + + - name: Archive documentation coverage results + uses: actions/upload-artifact@v3 + with: + name: docs-coverage-report + path: build/coverage/python.txt + - name: Test uninstall run: python3 -m pip uninstall -y reverse_argparse diff --git a/doc/source/conf.py b/doc/source/conf.py index 229482b..126cb1b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -14,7 +14,8 @@ project = "reverse_argparse" copyright = ( - "2023, National Technology & Engineering Solutions of Sandia, LLC (NTESS)" + "2023–2024, National Technology & Engineering Solutions of Sandia, LLC " + "(NTESS)" ) author = "Jason M. Gates" version = "1.0.6"