From 13544c91c2f40d684a0736ccf38f86d7b6a8b2b0 Mon Sep 17 00:00:00 2001 From: Jun Luo <4catcode@gmail.com> Date: Tue, 2 Jan 2024 21:06:14 +0800 Subject: [PATCH] chore: add readthedocs config (#8) --- .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ docs/requirements.txt | 1 - 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..fc79b81 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# .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.12" + rust: "1.70" + jobs: + pre_install: + - pip install maturin + - maturin build --release + - pip install target/wheels/fastcrc*.whl + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + builder: html + fail_on_warning: false + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt + +# Build PDF & ePub +formats: + - epub + - pdf \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index d542401..1b3a6e8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1 @@ -fastcrc==0.3.0 sphinx \ No newline at end of file