Skip to content

Commit

Permalink
Create Read the Docs yaml configuration (#173)
Browse files Browse the repository at this point in the history
Adds a Read the Docs yaml configuration file, following the Configuration File V2 syntax: https://docs.readthedocs.io/en/stable/config-file/v2.html

This allows to configure and modify Read the Docs from a single, Git-trackable file.

* Create .readthedocs.yaml
* added myst-parser to docs option in toml

Co-authored-by: Jan Kwakkel <[email protected]>
  • Loading branch information
EwoutH and quaquel authored Sep 20, 2022
1 parent 6ca0178 commit 5aaa46e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ all = ["ema_workbench[jupyter,dev,cov,docs,graph,parallel]"]
jupyter = ["jupyter", "jupyter_client", "ipython", "ipykernel"]
dev = ["pytest", "jupyter_client", "ipyparallel"]
cov = ["pytest-cov", "coverage", "coveralls"]
docs = ["sphinx", "nbsphinx", "myst", "pyscaffold"]
docs = ["sphinx", "nbsphinx", "myst", "pyscaffold", "myst-parser"]
graph = ["altair", "pydot", "graphviz"]
parallel = ["ipyparallel", "traitlets"]

Expand Down

0 comments on commit 5aaa46e

Please sign in to comment.