Skip to content

Commit

Permalink
Add docs (#10)
Browse files Browse the repository at this point in the history
* start of working autodocs and setup for readthedocs
  • Loading branch information
AndrewAnnex committed Aug 13, 2020
1 parent c261200 commit a0cada1
Show file tree
Hide file tree
Showing 10 changed files with 335 additions and 74 deletions.
29 changes: 29 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

build:
image: stable

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# fail_on_warning: true # < enable later...

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- epub
- pdf

# use a conda environment
conda:
environment: docs/asap_docs.yml

python:
version: 3.6
install:
- method: pip
path: .

0 comments on commit a0cada1

Please sign in to comment.