Skip to content

Commit

Permalink
Add docs upload workflow
Browse files Browse the repository at this point in the history
Signed-off-by: staticdev <[email protected]>
  • Loading branch information
staticdev authored and sigmavirus24 committed Dec 15, 2023
1 parent 94541f8 commit 99a011d
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 1 deletion.
45 changes: 45 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Check documentation

"on":
schedule:
- cron: "0 1 * * *" # everyday at 1am
push:
paths:
- "**.rst"
- "docs/**"
pull_request:
paths:
- "**.rst"
- "docs/**"

jobs:
docs:
name: Build documentation & check links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.11"

- name: Upgrade pip
run: |
pip install -U pip
pip --version
- name: Install Tox
run: |
pip install tox
tox --version
- name: Build documentation
run: tox
env:
TOXENV: docs

- name: Upload documentation
uses: actions/upload-artifact@v3
with:
name: docs
path: docs/_build
12 changes: 12 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: docs/source/conf.py
formats: all
python:
install:
- requirements: docs/source/requirements.txt
- path: .
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ deps =
build
.
commands =
sphinx-build -E -W -c docs/source/ -b html docs/source/ docs/build/html
sphinx-build -E -W -c docs/source/ -b html docs/source/ docs/_build/html
python -mbuild -s
twine check --strict dist/*

Expand Down

0 comments on commit 99a011d

Please sign in to comment.