From e7ffccc57b289793a5d15f3900a041a2ac9eea28 Mon Sep 17 00:00:00 2001 From: Caleb Hattingh Date: Sun, 10 Sep 2023 22:44:53 +0200 Subject: [PATCH] doc: configure ReadTheDocs (#120) --- .readthedocs.yaml | 33 +++++++++++++++++++++++++++++++++ docs/requirements.txt | 1 + pyproject.toml | 1 - 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..18465fe --- /dev/null +++ b/.readthedocs.yaml @@ -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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..1a16205 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +mkdocs==1.4.3 diff --git a/pyproject.toml b/pyproject.toml index d8db0e5..1632cef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,6 @@ requires-python = ">=3.7" [project.optional-dependencies] dev = [ "nox", - "mkdocs", ] [tool.maturin]