-
Notifications
You must be signed in to change notification settings - Fork 404
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: staticdev <[email protected]>
- Loading branch information
1 parent
94541f8
commit 99a011d
Showing
3 changed files
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters