Skip to content

Commit

Permalink
Configure for readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
agricolab committed Dec 13, 2019
1 parent ff915a4 commit ffb3d54
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

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

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- method: pip
path: .
- requirements: docs/requirements.txt
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
git+https://github.com/labstreaminglayer/liblsl-Python.git
sphinx-autodoc-typehints
sphinx-rtd-theme

0 comments on commit ffb3d54

Please sign in to comment.