From e43765ad968dad1663a4959e5614d352bbb2f6cc Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Fri, 10 May 2024 14:29:19 -0400 Subject: [PATCH 1/3] docs: update uv instructions --- docs/user/build-customization.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index d74f81c6185..8734fd79d90 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -359,8 +359,8 @@ Take a look at the following example: Install dependencies with ``uv`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Projects managed with `uv `__, -can use the ``post_create_environment`` user-defined job to use ``uv`` for installing Python dependencies. +Projects can use `uv `__, +to install Python dependencies, usually reducing the time taken to install compared to pip, possibly dramatically. Take a look at the following example: @@ -373,19 +373,15 @@ Take a look at the following example: os: "ubuntu-22.04" tools: python: "3.10" - jobs: - post_create_environment: - # Install uv - - pip install uv - post_install: - # Install dependencies with 'docs' dependency group - # VIRTUAL_ENV needs to be set manually for now. - # See https://github.com/readthedocs/readthedocs.org/pull/11152/ - - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install .[docs] - - sphinx: - configuration: docs/conf.py - + commands: + - asdf plugin add uv + - asdf install uv latest + - asdf global uv latest + - uv venv + - uv pip install .[docs] + - .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html + +You can use ``-r docs/requirements.txt``, etc. instead as needed. And mkdocs would use ``.venv/bin/python -m mkdocs build --site-dir $READTHEDOCS_OUTPUT/html``. Update Conda version ^^^^^^^^^^^^^^^^^^^^ From 9023980f6d6c5945161a0292351aaf88e002a049 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Sun, 12 May 2024 15:21:48 -0400 Subject: [PATCH 2/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 8734fd79d90..a7d6191774f 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -381,7 +381,7 @@ Take a look at the following example: - uv pip install .[docs] - .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html -You can use ``-r docs/requirements.txt``, etc. instead as needed. And mkdocs would use ``.venv/bin/python -m mkdocs build --site-dir $READTHEDOCS_OUTPUT/html``. +You can use ``-r docs/requirements.txt``, etc. instead as needed. And mkdocs would use ``NO_COLOR=1 .venv/bin/mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html``. Update Conda version ^^^^^^^^^^^^^^^^^^^^ From cafc15f6b79e911819154118d2bd548bbca08820 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Tue, 14 May 2024 17:02:47 +0200 Subject: [PATCH 3/3] Apply suggestions from code review --- docs/user/build-customization.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index a7d6191774f..d82a3cc9f8f 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -360,7 +360,7 @@ Install dependencies with ``uv`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Projects can use `uv `__, -to install Python dependencies, usually reducing the time taken to install compared to pip, possibly dramatically. +to install Python dependencies, usually reducing the time taken to install compared to pip. Take a look at the following example: @@ -381,7 +381,7 @@ Take a look at the following example: - uv pip install .[docs] - .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html -You can use ``-r docs/requirements.txt``, etc. instead as needed. And mkdocs would use ``NO_COLOR=1 .venv/bin/mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html``. +You can use ``-r docs/requirements.txt``, etc. instead as needed. MkDocs projects could use ``NO_COLOR=1 .venv/bin/mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html`` instead. Update Conda version ^^^^^^^^^^^^^^^^^^^^