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

Jump to bottom

docs(v3): small fixes #3942

Open
wants to merge 4 commits into
base: v3.0
Choose a base branch
from
Open

docs(v3): small fixes #3942

wants to merge 4 commits into from

Conversation

JacobCoffee
Copy link
Member

Description

  • fixes wording on table
  • fixes code colorway (sidestream changes also in litestar-sphinx-theme v3 branch)
  • (needs review?) add missing example files

@JacobCoffee JacobCoffee requested review from provinzkraut and a team as code owners January 10, 2025 06:22
@github-actions github-actions bot added area/dependencies This PR involves changes to the dependencies area/docs This PR involves changes to the documentation size: small type/docs labels Jan 10, 2025
JacobCoffee
JacobCoffee commented Jan 10, 2025
View reviewed changes
docs/examples/static_files/upgrade_from_static_1.py Outdated
Copy link
Member Author

Choose a reason for hiding this comment

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

y are these even needed though?

Copy link
Contributor

Choose a reason for hiding this comment

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

I dont think so since this is deprecated in v2

euri10
euri10 approved these changes Jan 10, 2025
View reviewed changes
docs/examples/static_files/upgrade_from_static_1.py Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

I dont think so since this is deprecated in v2

pyproject.toml
#[tool.uv.sources]
# Only needed when working on the theme; also need to uncomment docs package
#litestar-sphinx-theme = { path = "../litestar-sphinx-theme", editable = true }

Copy link
Contributor

Choose a reason for hiding this comment

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

it feels weird to have to comment / uncomment to work on docs, or there's something I dont get, isn't there a better way ?

Copy link
Member

@cofin cofin Jan 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, I think you can use something like this

with this in the pyproject.toml as well:

[tool.hatch.metadata]
allow-direct-references = true

Copy link
Member Author

Choose a reason for hiding this comment

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

Would this work? The issue I am fighting and that this solves currently is that I can have a locally checked out copy of litestar-sphinx-theme and can uncomment this section and the one in the docs = [...] group so that changes can be seen live across the project without having to push upstream or something.

Copy link
Member

Choose a reason for hiding this comment

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

Yep. I think this should handle this case.

@provinzkraut provinzkraut enabled auto-merge (squash) January 12, 2025 18:40
@github-actions github-actions bot added area/asgi area/channels area/connection area/constants This PR involves changes to the constants area/contrib This PR involves changes to the contrib (Deprecated) area/controller area/enums This PR involves changes to the enums area/handlers This PR involves changes to the handlers area/kwargs area/logging area/middleware This PR involves changes to the middleware area/openapi This PR involves changes to the OpenAPI schema area/private-api This PR involves changes to the privatized API area/response and removed size: small labels Jan 15, 2025
@github-actions github-actions bot added area/template area/testing area/types This PR involves changes to the custom types size: large labels Jan 15, 2025
@github-actions github-actions bot added size: small and removed area/enums This PR involves changes to the enums area/controller area/connection area/constants This PR involves changes to the constants area/template area/types This PR involves changes to the custom types area/response area/static-files area/logging area/middleware This PR involves changes to the middleware area/asgi area/kwargs size: large area/private-api This PR involves changes to the privatized API area/handlers This PR involves changes to the handlers area/testing area/openapi This PR involves changes to the OpenAPI schema area/channels area/contrib This PR involves changes to the contrib (Deprecated) area/router labels Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cofin cofin cofin left review comments

@euri10 euri10 euri10 approved these changes

@provinzkraut provinzkraut Awaiting requested review from provinzkraut provinzkraut is a code owner

Assignees
No one assigned
Labels
area/dependencies This PR involves changes to the dependencies area/docs This PR involves changes to the documentation pr/internal size: small type/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JacobCoffee @cofin @euri10