Skip to content

Commit

Permalink
doc: configure ReadTheDocs (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
cjrh authored Sep 10, 2023
1 parent e236af0 commit e7ffccc
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
33 changes: 33 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs==1.4.3
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ requires-python = ">=3.7"
[project.optional-dependencies]
dev = [
"nox",
"mkdocs",
]

[tool.maturin]
Expand Down

0 comments on commit e7ffccc

Please sign in to comment.