Typer API Documentation (or: Where do I find the arguments to Typer())?

[linsomniac]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

N/A, this is a documentation discussion.

Description

I really like Typer, but one thing I struggle with is the "narrative style" tutorial documentation; it's really good for getting started, but I really struggle with using it to answer questions like "What documentation options do I have in the "Typer()" call?" I end up clicking all around and hunting for something that answers my question. For example, searching for "epilog" in the typer documentation doesn't list it as being an option to Typer(), but it is.

What I'm thinking is:

• Adding Docstrings to Typer() and friends, including documenting arguments.
• Adding an "API Docs" or similar to the mkdocs nav.
• Adding "docs/api/index.md" (or possibly others) that uses mkdocstrings to pull in the documentation from the docstrings.

Thoughts? Am I missing some documentation?

Operating System

Linux

Operating System Details

No response

Typer Version

0.9.0

Python Version

3.11

Additional Context

No response

[9999years]

I would also like this. I can't find anywhere that lists or explains the typer.Option arguments, for instance, and many of them are not documented in the tutorial-style documentation either. (What's allow_from_autoenv? expose_value? shell_complete vs. autocompletion?)

[svlandeg]

FYI - on the topic of shell_complete vs autocompletion - we've decided to only keep the latter and not support the former, to avoid confusion. Cf #949 and #974.

[svlandeg]

I see your point - I'll label this as a feature request.

In the meantime, while it's not fully complete yet, you might enjoy looking at this user contribution: #634 -> Cheat sheet

[gcr]

Strong agree.These docs and others (looking at you, sqlmodel :) ) seem to lack "readthedocs"-style API references for each class, which is a significant problem in my book.

It's great that there's high-quality material for beginners -- I wish more libraries had this -- but it also makes complex issues with this library impossible to debug.

(Thx for a great library btw!)

[mihaic]

Related issue:
#221

[gcr]

if one of us outsiders were to just start to write some docstrings and send a pull request, would that be considered? Or would the contributor team prefer to coordinate this effort when the time is right?

[svlandeg]

Hi all! I just discussed this with Tiangolo and we agreed I'll work on this. I'll prioritize this in the next few weeks. If there's an easy way to help out (while still ensuring things are coordinated), I'll let you know here. Thanks!

[svlandeg]

Draft PR: #1504

[svlandeg]

The typer reference docs are now available here: https://typer.tiangolo.com/reference/

[gcr]

oh these look awesome!! Thank you!