Skip to content

Commit

Permalink
chore: add readthedocs config (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Jan 2, 2024
1 parent c66d910 commit 13544c9
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
fastcrc==0.3.0
sphinx

0 comments on commit 13544c9

Please sign in to comment.