Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: pin to Python 3.12 for docs commands only; fix contributing docs #3953

Merged
merged 4 commits into from
Jan 17, 2025
Merged

chore: pin to Python 3.12 for docs commands only; fix contributing docs #3953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f33d34a
docs: fix command for installing dev requirements
sloria Jan 15, 2025
f015b1f
Merge branch 'main' into fix-contrib-docs
sloria Jan 17, 2025
c6b9bf0
pin to Python 3.12 for docs commands
sloria Jan 17, 2025
398893e
docs: remove outdated URL for local documentation serving
sloria Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ the environment will bootstrap itself automatically. The steps below are for loc
#. Install `uv <https://docs.astral.sh/uv/getting-started/installation/>`_:

#. Run ``make install`` to create a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_
and install the required development dependencies or run the uv sync command manually:
and install the required development dependencies or run the ``uv sync`` command manually:

.. code-block:: shell
:caption: Installing the documentation dependencies
:caption: Installing the development dependencies

uv install
uv sync


.. tip:: Many modern IDEs like PyCharm or VS Code will enable the uv-managed virtualenv that is created in step 2
Expand Down
14 changes: 8 additions & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ upgrade: ## Upgrade all dependencies to the latest stable versio

.PHONY: install
install:
@uv sync --python 3.12
@uv sync
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might want to add --frozen so people don't inadvertently update the lockfile, but i'm not 100% sure so left that alone


.PHONY: clean
clean: ## Cleanup temporary build artifacts
Expand Down Expand Up @@ -121,10 +121,12 @@ check-all: lint test-all coverage ## Run all linting, tests, a
# =============================================================================
# Docs
# =============================================================================
# XXX: docs commands are pinned to Python 3.12 due to picologging not being compatible with 3.13

.PHONY: docs-install
docs-install: ## Install docs dependencies
@echo "=> Installing documentation dependencies"
@uv install --group docs
@uv sync --python 3.12 --group docs
@echo "=> Installed documentation dependencies"

docs-clean: ## Dump the existing built docs
Expand All @@ -134,16 +136,16 @@ docs-clean: ## Dump the existing built docs

docs-serve: docs-clean ## Serve the docs locally
@echo "=> Serving documentation"
uv run sphinx-autobuild docs docs/_build/ -j auto --watch litestar --watch docs --watch tests --watch CONTRIBUTING.rst --open-browser
uv run --python 3.12 sphinx-autobuild docs docs/_build/ -j auto --watch litestar --watch docs --watch tests --watch CONTRIBUTING.rst --open-browser

docs: docs-clean ## Dump the existing built docs and rebuild them
@echo "=> Building documentation"
@uv run sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going
@uv run --python 3.12 sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going

.PHONY: docs-linkcheck
docs-linkcheck: ## Run the link check on the docs
@uv run sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_ignore='http://.*','https://.*'
@uv run --python 3.12 sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_ignore='http://.*','https://.*'

.PHONY: docs-linkcheck-full
docs-linkcheck-full: ## Run the full link check on the docs
@uv run sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_anchors=0
@uv run --python 3.12 sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_anchors=0
Loading