From ffb3d5447c85dff7f0c78f6bf1eefa9808914f5e Mon Sep 17 00:00:00 2001 From: agricolab Date: Fri, 13 Dec 2019 12:34:07 +0100 Subject: [PATCH] Configure for readthedocs --- .readthedocs.yml | 27 +++++++++++++++++++++++++++ docs/requirements.txt | 3 +++ 2 files changed, 30 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..b6bf054 --- /dev/null +++ b/.readthedocs.yml @@ -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 \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..6e5418a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +git+https://github.com/labstreaminglayer/liblsl-Python.git +sphinx-autodoc-typehints +sphinx-rtd-theme \ No newline at end of file