From e513d27ba87fb388491161a5c274fbe6c266b5e7 Mon Sep 17 00:00:00 2001 From: Jun Luo <4catcode@gmail.com> Date: Tue, 2 Jan 2024 20:56:42 +0800 Subject: [PATCH 1/4] chore: add readthedocs config --- .readthedocs.yaml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..eb275bf --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,31 @@ +# .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" + +# 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: + - method: pip + path: . + - requirements: docs/requirements.txt + +# Build PDF & ePub +formats: + - epub + - pdf \ No newline at end of file From 66710eeaea88e0eb6e9b6d0ae82feea3d5aaa096 Mon Sep 17 00:00:00 2001 From: Jun Luo <4catcode@gmail.com> Date: Tue, 2 Jan 2024 20:57:30 +0800 Subject: [PATCH 2/4] chore: add readthedocs config --- .readthedocs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index eb275bf..d1bc68e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -21,8 +21,6 @@ sphinx: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - method: pip - path: . - requirements: docs/requirements.txt # Build PDF & ePub From 3be793fa1f02c067ac4c53fa99303bf04db649df Mon Sep 17 00:00:00 2001 From: Jun Luo <4catcode@gmail.com> Date: Tue, 2 Jan 2024 21:01:41 +0800 Subject: [PATCH 3/4] chore: add readthedocs config --- .readthedocs.yaml | 6 ++++++ docs/requirements.txt | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d1bc68e..0c99273 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,6 +10,12 @@ build: os: ubuntu-22.04 tools: python: "3.12" + rust: "1.76" + jobs: + pre_install: + - pip install maturin + - maturin build --release + - pip install target/wheels/fastcrc*.whl # Build documentation in the docs/ directory with Sphinx sphinx: 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 From bb579f36851920768d40adf2a83c6b26e95ddc96 Mon Sep 17 00:00:00 2001 From: Jun Luo <4catcode@gmail.com> Date: Tue, 2 Jan 2024 21:02:41 +0800 Subject: [PATCH 4/4] chore: add readthedocs config --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0c99273..fc79b81 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,7 +10,7 @@ build: os: ubuntu-22.04 tools: python: "3.12" - rust: "1.76" + rust: "1.70" jobs: pre_install: - pip install maturin