Skip to content

Commit 99a011d

Browse files
staticdevsigmavirus24
authored andcommitted
Add docs upload workflow
Signed-off-by: staticdev <[email protected]>
1 parent 94541f8 commit 99a011d

File tree

3 files changed

+58
-1
lines changed

3 files changed

+58
-1
lines changed

.github/workflows/docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Check documentation
3+
4+
"on":
5+
schedule:
6+
- cron: "0 1 * * *" # everyday at 1am
7+
push:
8+
paths:
9+
- "**.rst"
10+
- "docs/**"
11+
pull_request:
12+
paths:
13+
- "**.rst"
14+
- "docs/**"
15+
16+
jobs:
17+
docs:
18+
name: Build documentation & check links
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: actions/setup-python@v4
23+
with:
24+
python-version: "3.11"
25+
26+
- name: Upgrade pip
27+
run: |
28+
pip install -U pip
29+
pip --version
30+
31+
- name: Install Tox
32+
run: |
33+
pip install tox
34+
tox --version
35+
36+
- name: Build documentation
37+
run: tox
38+
env:
39+
TOXENV: docs
40+
41+
- name: Upload documentation
42+
uses: actions/upload-artifact@v3
43+
with:
44+
name: docs
45+
path: docs/_build

.readthedocs.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
build:
3+
os: ubuntu-22.04
4+
tools:
5+
python: "3.11"
6+
sphinx:
7+
configuration: docs/source/conf.py
8+
formats: all
9+
python:
10+
install:
11+
- requirements: docs/source/requirements.txt
12+
- path: .

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ deps =
104104
build
105105
.
106106
commands =
107-
sphinx-build -E -W -c docs/source/ -b html docs/source/ docs/build/html
107+
sphinx-build -E -W -c docs/source/ -b html docs/source/ docs/_build/html
108108
python -mbuild -s
109109
twine check --strict dist/*
110110

0 commit comments

Comments
 (0)