typer/docs
Sebastián Ramírez 15380ddc07
Add support for help for CLI arguments (#123)
*  Implement custom TyperCommand and TyperArgument

to support help in CLI Arguments

*  Update data models to store help for CLI Arguments

*  Add help to typer.Argument()

*  Use new TyperCommand and TyperArgument classes by default

to support CLI Arguments with help

*  Update failing test

*  Make showing default values default to true and support arguments hidden from help text

*  Add docs for CLI arguments with defaults, help, and new features

* 📝 Update CLI options with new show_default=True by default

* 📝 Add example of CLI arguments with tuples

* 📝 Update docs with new generated help text for CLI arguments

* 📝 Use Optional for None example in micro-intro to types

*  Add tests for new CLI argument features from docs examples

*  Update tests with new generated help text for CLI arguments

*  Add tests for CLI arguments with tuple defaults

* 🔧 Update MkDocs with new sections

*  make show_envvar default to True

*  Add docs for envvar in CLI arguments

*  Add tests for CLI arguments with env vars from docs

* 🎨 Add format to CLI usage examples in docs

* 🔧 Add section about CLI arguments with env vars to MkDocs

* 📝 Fix link in docs with new structure

* 🎨 Fix format in first-steps
2020-06-24 21:05:21 +02:00
..
css 📝 Refactor docs with internal links 2020-01-18 19:35:49 +01:00
img 🍱 Add GitHub social preview images 2019-12-24 21:15:16 +01:00
js Upgrade Material-Mkdocs (#90) 2020-04-18 12:38:12 +02:00
src Add support for help for CLI arguments (#123) 2020-06-24 21:05:21 +02:00
tutorial Add support for help for CLI arguments (#123) 2020-06-24 21:05:21 +02:00
alternatives.md Add docs for testing, password, version, context. Extra tests, include callback and autocompletion PR (#68) 2020-03-18 21:17:47 +01:00
contributing.md Upgrade Material-Mkdocs (#90) 2020-04-18 12:38:12 +02:00
features.md white_check_mark: Add coverage instructions to tests (#72) 2020-03-19 14:44:43 +01:00
help-typer.md 🎨 Tweak external link format 2020-01-17 16:27:17 +01:00
index.md Add support for help for CLI arguments (#123) 2020-06-24 21:05:21 +02:00
release-notes.md 📝 Update release notes 2020-06-23 14:54:34 +02:00
typer-cli.md 📝 Sync Typer CLI docs, Coverage badge 2020-04-26 16:27:58 +02:00