Skip to content

Commit

Permalink
Added yml for read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rmj3197 committed Mar 10, 2024
1 parent 58ca591 commit c6c6e97
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c6c6e97

Please sign in to comment.