From addb72cc70101b8f30896eafd1146d0e97888809 Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Wed, 22 Jan 2025 19:50:02 -0500 Subject: [PATCH 1/3] More concise uv example This provides a more succinct uv example using `uv sync` --- docs/user/build-customization.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index fce8c2bc5fb..045cebdf2b5 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -26,7 +26,7 @@ The jobs where users can customize our default build process are: :header-rows: 1 :widths: 25 75 - * - Step + * - Stepf - Customizable jobs * - Checkout - ``post_checkout`` @@ -460,6 +460,9 @@ Take a look at the following example: version: 2 + sphinx: + configuration: docs/conf.py + build: os: ubuntu-24.04 tools: @@ -469,14 +472,8 @@ Take a look at the following example: - asdf plugin add uv - asdf install uv latest - asdf global uv latest - - uv venv install: - - uv pip install -r requirements.txt - build: - html: - - uv run sphinx-build -T -b html docs $READTHEDOCS_OUTPUT/html - -MkDocs projects could use ``NO_COLOR=1 uv run mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html`` instead. + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --extra docs Update Conda version ~~~~~~~~~~~~~~~~~~~~ From 9aa5bf9a13536b43edaa00eecd0b8ac7bc56851c Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Thu, 23 Jan 2025 22:41:20 -0500 Subject: [PATCH 2/3] Better version of what I did --- docs/user/build-customization.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index 045cebdf2b5..eab8f610ee7 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -468,12 +468,14 @@ Take a look at the following example: tools: python: "3.13" jobs: - create_environment: + post_system_dependencies: - asdf plugin add uv - asdf install uv latest - asdf global uv latest + create_environment: + - uv venv "${READTHEDOCS_VIRTUALENV_PATH}" install: - - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --extra docs + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs Update Conda version ~~~~~~~~~~~~~~~~~~~~ From 417118116ff9f65cb801f31a8115e81f4be23732 Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Thu, 23 Jan 2025 22:41:47 -0500 Subject: [PATCH 3/3] Update docs/user/build-customization.rst --- docs/user/build-customization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index eab8f610ee7..b3e3f4851a0 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -26,7 +26,7 @@ The jobs where users can customize our default build process are: :header-rows: 1 :widths: 25 75 - * - Stepf + * - Step - Customizable jobs * - Checkout - ``post_checkout``