Skip to content

Commit

Permalink
Implement upload of project documentation on readthedocs.io (#30)
Browse files Browse the repository at this point in the history
* Add readthedocs.io config file

* Check docs generation in CI
  • Loading branch information
oncleben31 authored Nov 1, 2020
1 parent dfc7982 commit 12a41c4
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/constraints.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
pip==20.2.4
pre-commit==2.8.2
nox==2020.8.22
18 changes: 18 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Build documentation
on: [push, pull_request]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/[email protected]
with:
python-version: "3.8"
- run: |
pip install --constraint=.github/workflows/constraints.txt pip
pip install --constraint=.github/workflows/constraints.txt nox
- run: nox --force-color --session=docs
- uses: actions/upload-artifact@v2
with:
name: docs
path: docs/_build
8 changes: 8 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
sphinx:
configuration: docs/conf.py
formats: all
python:
version: 3.8
install:
- requirements: docs/requirements.txt

0 comments on commit 12a41c4

Please sign in to comment.