doc: configure ReadTheDocs (#120)

master
Caleb Hattingh 2023-09-10 22:44:53 +02:00 committed by GitHub
parent e236af0a06
commit e7ffccc57b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 34 additions and 1 deletions

33
.readthedocs.yaml Normal file
View File

@ -0,0 +1,33 @@
# .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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx
mkdocs:
configuration: mkdocs.yml
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt

1
docs/requirements.txt Normal file
View File

@ -0,0 +1 @@
mkdocs==1.4.3

View File

@ -9,7 +9,6 @@ requires-python = ">=3.7"
[project.optional-dependencies]
dev = [
"nox",
"mkdocs",
]
[tool.maturin]