📝 Add reference (code API) docs

[svlandeg]

Reference docs for Typer 🚀

• Add reference docs menu to the top navigation bar of the Typer docs
• Add following items to the reference docs (defined in mkdocs.yml):
  • index.md
  • typer.md: everything about Typer()
  • run_launch.md: about typer.run() and typer.launch()
  • parameters.md: all details about Argument() and Option
  • file_objects.md: FileBinaryRead, FileBinaryWrite, FileText, FileTextWrite
  • context.md: Context and CallbackParam
• Added links to the tutorial where relevant
• Add annotated-doc as project requirement

Special cases

Undocumented functionality

The following stuff isn't documented in our Tutorial docs, and in the reference docs here I include a note saying something like

Note: you probably shouldn't use this parameter, it is inherited from Click and supported for compatibility.

then followed by a quick description from the Click docs.

From main.py:

• subcommand_metavar in main.py
• chain in main.py
• result_callback in main.py
• add_help_option in main.py

From params.py:

• expose_value in params.py
• prompt_required in params.py
• errors (for a file) in params.py
• show_choices in params.py
• allow_from_autoenv in params.py

Marked as "will be deprecated"

The following have gotten the following note:

Note: you probably shouldn't use this parameter, it is inherited from Click and supported for compatibility. It is however not fully functional, and will likely be removed in future versions.

From params.py:

• shell_complete in params.py
• is_flag in params.py
• flag_value in params.py

Should perhaps be documented in the tutorial?

• hidden in main.py (we only document hidden for parameters, not for commands)

Open questions

Any other things that need documenting?

I was thinking about Abort, BadParameter, Exit but these come directly from Click and so the way of documenting these would be different (i.e. not via docstrings).

[github-actions]

📝 Docs preview

Last commit 0e57ee9 at: https://2d1215f6.typertiangolo.pages.dev

Modified Pages

• https://2d1215f6.typertiangolo.pages.dev/reference/ - (before)
• https://2d1215f6.typertiangolo.pages.dev/reference/context/ - (before)
• https://2d1215f6.typertiangolo.pages.dev/reference/file_objects/ - (before)
• https://2d1215f6.typertiangolo.pages.dev/reference/parameters/ - (before)
• https://2d1215f6.typertiangolo.pages.dev/reference/run_launch/ - (before)
• https://2d1215f6.typertiangolo.pages.dev/reference/typer/ - (before)