diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..676ddaf0 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,39 @@ +--- +name: Docs + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + docs: + name: Build documentation + runs-on: ubuntu-22.04 + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up Python + 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 + pip install -e .[devel-docs] + - name: Build documentation + run: | + cd docs + make html + - name: Run doctests + run: | + cd docs + make doctest 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 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 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) 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 =====================================