From 4a08f186310623658d4ee3a828672100756c9357 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Thu, 18 Apr 2024 16:20:20 -0400 Subject: [PATCH] docs: setup uv for readthedocs (#54) * docs: setup uv for readthedocs * Update .readthedocs.yaml * require sphinx >=4.2 --- .readthedocs.yaml | 11 +++++------ docs/requirements.txt | 1 + 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3a99f8a..e9d6777 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,15 +10,14 @@ build: os: ubuntu-22.04 tools: python: "3.10" - + jobs: + post_create_environment: + - pip install uv + post_install: + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install -r docs/requirements.txt # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # If using Sphinx, optionally build your docs in additional formats such as PDF formats: all - -# Optionally declare the Python requirements required to build your docs -python: - install: - - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt index fe49768..5989729 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ +sphinx >=4.2 sphinx_rtd_theme . myst_parser