docs(v3): small fixes #3942
Open
docs(v3): small fixes #3942
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area/dependencies
JacobCoffee
commented
Jan 10, 2025
There was a problem hiding this comment.
y are these even needed though?
There was a problem hiding this comment.
I dont think so since this is deprecated in v2
euri10
approved these changes
Jan 10, 2025
There was a problem hiding this comment.
I dont think so since this is deprecated in v2
| #[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 } | ||
|
|
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
Yes, I think you can use something like this
with this in the pyproject.toml as well:
[tool.hatch.metadata]
allow-direct-references = trueThere was a problem hiding this comment.
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.
There was a problem hiding this comment.
Yep. I think this should handle this case.
provinzkraut
force-pushed
the
v3-fixes
branch
from
d29d3ab to
5229717
Compare
* Trigger documentation build * Trigger documentation build * docs: update to v3 style * docs: move some things to litestar.dev repo, change versioning, add environment tag * docs: update landing page * chore: update lockfile * chore: add AA upper constraint * fix(docs): re-colonize * docs: enable sphinx-togglebutton * docs: use current year var * deps: update deps * fix(docs): do not link __name__ for now * fix(docs): use correct link to page --------- Co-authored-by: Peter Schutt <[email protected]>
* Remove deprecated StaticFiles and StaticFilesConfig * remove special casing of static files app from handlers/router * remove outdated docs sections * Add what's new section * Rename tests for consistency
This PR changes behavior of parameters that are typed in a union with `None`. Prior behavior was to implicitly default their value to `None` if a value wasn't provided making an apparently non-optional parameter (i.e., no declared default) actually optional. Surprising behavior at best, dangerous at worst. New behavior is to throw a client error when a parameter without a default is not provided.
* refactor: removes deprecated OpenAPIController This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach. * docs: What's new entry * Update docs/usage/openapi/ui_plugins.rst Co-authored-by: Jacob Coffee <[email protected]> * Update litestar/openapi/config.py * fix: remove whitespace * fix: import table formatting (i hope) --------- Co-authored-by: Jacob Coffee <[email protected]>
…e` (#3393) * Remove 'app' parameter from `.to_asgi_response`
Remove the deprecated utility functions, `get_litestar_scope_state``, ``set_litestar_scope_state``, ``delete_litestar_scope_state``, and ``is_sync_or_async_generator``.
* remove handler names * Remove option handler creation from HTTPRoute * Remove methods attribute from BaseRoute * Move kwargs model to handlers and creation to on_registration * Store kwargs model on handlers instead of routes * Simplify HTTPRoute route_handler_map creation * Simplify Router.route_handler_method_map * Relax typing of HTTPRoute * Move handling logic to route handlers * Remove scope_type * Don't pass route to HTTPRouteHandler during handling * Don't pass scope to handle methods * Resolve and establish connections in routes; Only pass connections to handlers --------- Co-authored-by: Jacob Coffee <[email protected]> Co-authored-by: Peter Schutt <[email protected]>
* Backport static files path traversal fix
* make route handlers functional decorators
…ors (#3529) Remove deprecated test
ignore type error
github-actions
bot
removed
area/enums
provinzkraut
force-pushed
the
v3.0
branch
2 times, most recently
from
f541bd2 to
dbf055e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description