diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..47fb752 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,31 @@ +# .readthedocs.yml +# 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.9' + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/source/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt + +submodules: + include: all + recursive: true \ No newline at end of file diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..fcd9d85 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +myst-parser>=0.16 +sphinx>=4.0 +sphinx-autobuild>=2021.0 +sphinx-book-theme>=1.0 +nbsphinx>0.9 +ipykernel +QuadratiK \ No newline at end of file