From c15b467d373e804d0c5884bff7e59d9d4912f267 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 12:07:06 -0500 Subject: [PATCH 1/7] Add docs build test to CI --- .github/workflows/docs.yml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..da0e8817 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,35 @@ +--- +name: Documentation + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + docs: + name: Build documentation + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.11" + - name: Install dependencies + run: | + pip install --upgrade pip setuptools + pip install -e .[devel-docs] + - name: Build documentation + run: | + cd docs + make html + - name: Run doctests + run: | + cd docs + make doctest From 1b775cae92691f81e90927cab65f9ec64ec35021 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 12:19:35 -0500 Subject: [PATCH 2/7] test: install python3-dev doc build needs C ext Co-Authored-By: Claude --- .github/workflows/docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index da0e8817..e5de832d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,6 +21,10 @@ jobs: uses: actions/setup-python@v4 with: python-version: "3.11" + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y python3-dev build-essential - name: Install dependencies run: | pip install --upgrade pip setuptools From 81f791177d4391182defedf3b6ebe1ce3673d14f Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 12:31:39 -0500 Subject: [PATCH 3/7] fixup ubuntu 22 to match other CI --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e5de832d..676ddaf0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,5 +1,5 @@ --- -name: Documentation +name: Docs on: push: @@ -12,7 +12,7 @@ on: jobs: docs: name: Build documentation - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 steps: - name: Checkout From fa8df9542a2820f3c9e182b42ff9bc45de318212 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 12:58:29 -0500 Subject: [PATCH 4/7] fail if docs build warnings --- docs/Makefile | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 6e117df6..1f86fe92 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,9 +2,7 @@ # # You can set these variables from the command line. -# Treat warnings as errors.... hierarchy.rst is just a dump of notes ATM -# SPHINXOPTS = -W -SPHINXOPTS = +SPHINXOPTS = -W # sphinx-build might be coming from system-wide install, and would # use /usr/bin/python3 instead of /usr/bin/env python3, so it would not # find our module installed under virtualenv From b94d865439dc9979b163861b6299f51cb57db7d7 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 13:01:39 -0500 Subject: [PATCH 5/7] doc: fixup title underline length --- docs/source/execution.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/execution.rst b/docs/source/execution.rst index 12960520..474fc292 100644 --- a/docs/source/execution.rst +++ b/docs/source/execution.rst @@ -1,7 +1,7 @@ .. _execution: Execution on Resources -********************* +********************** Once a resource is present in your inventory (see :ref:`Managing resources `), ReproMan provides a few ways to execute command(s) From 4c2321c8a0fee7901dbebb05800779220059001c Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 13:05:56 -0500 Subject: [PATCH 6/7] remove test utils from docs not user-facing removal allows [devel-docs] to be sufficient to build docs --- docs/source/modref.rst | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/source/modref.rst b/docs/source/modref.rst index 0c2bbbd7..aa591bbb 100644 --- a/docs/source/modref.rst +++ b/docs/source/modref.rst @@ -45,15 +45,6 @@ Configuration management config -Test infrastructure -=================== - -.. currentmodule:: reproman -.. autosummary:: - :toctree: generated - - tests.utils - Command line interface infrastructure ===================================== From 764bc0a17a0b0bf18bad8a8974ee5e8fd036397d Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 3 Sep 2025 13:08:15 -0500 Subject: [PATCH 7/7] remove doc build and doctest from test job --- .github/workflows/test.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e6890a1e..5ab438dd 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -124,7 +124,5 @@ jobs: run: python setup.py build - name: Run tests run: python -m pytest -s -v -rsfE --integration --cov=reproman --cov-report=xml reproman - - name: Generate documentation and run doctests - run: PYTHONPATH=$PWD make -C docs html doctest - name: Upload coverage to codecov uses: codecov/codecov-action@v1