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.

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

Conversation

sloria
Copy link
Contributor

@sloria sloria commented Jan 15, 2025

Description

  • fix some typos in the contributing docs

Closes

@sloria sloria requested review from a team as code owners January 15, 2025 23:14
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/docs pr/external Triage Required 🏥 This requires triage labels Jan 15, 2025
@sloria
Copy link
Contributor Author

sloria commented Jan 15, 2025

@all-contributors add @sloria for docs

Copy link
Contributor

@sloria

I've put up a pull request to add @sloria! 🎉

@sloria
Copy link
Contributor Author

sloria commented Jan 15, 2025

hm, i hope i did things right 😬

CONTRIBUTING.rst Outdated

uv install
uv sync --python 3.12
Copy link
Member

Choose a reason for hiding this comment

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

Selecting a python version isn't really necessary here, and if you do select one, it should be the lowest supported version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was to align with the Makefile here:

@uv sync --all-extras --dev --python 3.12

should I change both to use 3.8?

fwiw, uv sync won't work its own doesn't work if you have python 3.13 installed. building the docs raises an error because picologging (which isn't python 3.13 compatible) isn't installed (it gets conditionally installed on python<3.13).

Copy link
Member

Choose a reason for hiding this comment

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

Hmm. For docs we should probably install --python=3.12 then and omit a specific version for everything else.

Copy link
Contributor Author

@sloria sloria Jan 17, 2025

Choose a reason for hiding this comment

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

done in c6b9bf0

@sloria sloria changed the title docs: fix command for installing dev requirements chore: pin to Python 3.12 for docs commands only; fix contributing docs Jan 17, 2025
@sloria sloria requested a review from provinzkraut January 17, 2025 18:51
@@ -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

Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3953

@provinzkraut provinzkraut merged commit 062c10b into litestar-org:main Jan 17, 2025
24 checks passed
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.34%. Comparing base (4af28b4) to head (398893e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3953      +/-   ##
==========================================
- Coverage   98.34%   98.34%   -0.01%     
==========================================
  Files         347      347              
  Lines       15743    15743              
  Branches     1740     1740              
==========================================
- Hits        15483    15482       -1     
- Misses        124      126       +2     
+ Partials      136      135       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sloria sloria deleted the fix-contrib-docs branch January 17, 2025 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation pr/external size: small Triage Required 🏥 This requires triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants