docs: update usage/cli
#3350
docs: update usage/cli
#3350
Conversation
github-actions
bot
added
area/docs
docs/usage/cli.rst
Outdated
| 2. An :term:`object` named ``application`` that is an instance of :class:`Litestar <.app.Litestar>` | ||
| 3. Any :term:`object` that is an instance of :class:`Litestar <.app.Litestar>` | ||
| 4. A :term:`callable` named ``create_app`` | ||
| 5. A :term:`callable` annotated to return an instance of :class:`Litestar <.app.Litestar>` | ||
|
|
||
| Commands | ||
| -------- |
There was a problem hiding this comment.
Okay hear me out - We have some unique things in here but with a big note to maintainability and scalability, they are not terribly useful compared to what the Click directive gives use (see https://docs.litestar.dev/latest/reference/cli.html)
@litestar-org/maintainers wdyt about removing this and just moving the reference of the commands up some.
My only concern is things like https://docs.litestar.dev/latest/usage/cli.html#ssl.
I was thinking we could enhance the help= for those commands but that file would become garagantuan.. I'm not sure of a better way. We could have a few sections I guess for special things like this - but I feel like they would become stale without us seeing it. The "Help" for those seems already good enough.. e.g., litestar run --help -> look at what the subcommands are.
Thoughts?
There was a problem hiding this comment.
This too coupled with this massive ass table.
We could move it to a csv or similar sphinx table structure but I don't think it solves my concerns.
There was a problem hiding this comment.
No pressure on just keeping it, too.
There was a problem hiding this comment.
I'd vote for better maintainability and a gargantuan cli file. We could also move the help strings for commands to another module as constants and import them into the cli module, if that would help alleviate.
docs/usage/cli.rst
Outdated
| 2. An :term:`object` named ``application`` that is an instance of :class:`Litestar <.app.Litestar>` | ||
| 3. Any :term:`object` that is an instance of :class:`Litestar <.app.Litestar>` | ||
| 4. A :term:`callable` named ``create_app`` | ||
| 5. A :term:`callable` annotated to return an instance of :class:`Litestar <.app.Litestar>` | ||
|
|
||
| Commands | ||
| -------- |
There was a problem hiding this comment.
I'd vote for better maintainability and a gargantuan cli file. We could also move the help strings for commands to another module as constants and import them into the cli module, if that would help alleviate.
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3350 |
Description
usage/clidocs as part of docs: update links, formatting, grammar, and remove contractions #3212 workCloses