Skip to content

Commit

Permalink
Add configuration for building documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Pankrat committed Dec 29, 2021
1 parent 03132a6 commit 975d630
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip wheel
pip install build Sphinx myst-parser pycodestyle coverage coveralls numpy mypy
pip install build pycodestyle coverage coveralls numpy mypy
pip install -r doc/requirements.txt
- name: Test
shell: bash
run: |
Expand Down
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.8"

sphinx:
configuration: doc/source/conf.py

python:
install:
- requirements: doc/requirements.txt
2 changes: 2 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx
myst-parser

0 comments on commit 975d630

Please sign in to comment.