Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Sphinx documentation #12

Merged
merged 16 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Documentation Check
on:
- pull_request

jobs:
sphinx:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: josh146/sphinx-action@master
with:
docs-folder: "docs/"
pre-build-command: "apt install -y graphviz && pip3 install . && pip3 install -r docs/requirements.txt"
build-command: "sphinx-build -b html . _build -W --keep-going"
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ instance/

# Sphinx documentation
docs/_build/
docs/api/

# PyBuilder
target/
Expand Down
14 changes: 14 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

sphinx:
configuration: docs/conf.py

python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .

build:
image: latest
210 changes: 0 additions & 210 deletions README.md

This file was deleted.

Loading