Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 1 addition & 3 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we really ready for this? ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it passed without errors.

The "discussion" docs have been moved to markdown in design/ which were probably causing most of the problems. I only had to make minimal changes to avoid.

The weird thing was that without this the doc build passed if it completed with errors (seems like it this should only affect warnings?) I guess non-fatal errors were treated as warnings?

# 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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/execution.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _execution:

Execution on Resources
*********************
**********************

Once a resource is present in your inventory (see :ref:`Managing
resources <manage>`), ReproMan provides a few ways to execute command(s)
Expand Down
9 changes: 0 additions & 9 deletions docs/source/modref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,6 @@ Configuration management

config

Test infrastructure
===================

.. currentmodule:: reproman
.. autosummary::
:toctree: generated

tests.utils

Command line interface infrastructure
=====================================

Expand Down