Skip to content

Commit

Permalink
adding test for building docs (#79)
Browse files Browse the repository at this point in the history
the docs build fails once in a while so we should test before merge

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Co-authored-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch and vsoch authored Nov 16, 2023
1 parent 9680ae6 commit 1d376ab
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .github/workflows/docs-test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: docs-test metrics-operator
on:
pull_request: []

jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Create conda environment
run: conda create --quiet -c conda-forge --name docs sphinx-material
- name: Generate Docs
run: |
export PATH="/usr/share/miniconda/bin:$PATH"
source activate docs
cd ./docs
pip install -r requirements.txt
make html
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
sphinx
markupsafe
sphinx_immaterial==0.11.7
sphinx_immaterial
numpy
pydantic
pandas
Expand Down

0 comments on commit 1d376ab

Please sign in to comment.