Sebastián Ramírez
a89fc4ebb7
white_check_mark: Add coverage instructions to tests ( #72 )
...
* ✅ Add coverage instructions to tests
* 📝 Update docs note about coverage in features
* 🎨 Fix format
* 🎨 Update testing docs format
2020-03-19 14:44:43 +01:00
Sebastián Ramírez
0830c023b9
📝 Add docs section, build a package from scratch ( #71 )
...
* 📝 Add docs section, build a package from scratch
* 📝 Update Package docs
* ✏️ Fix internal links
2020-03-19 13:42:23 +01:00
Sebastián Ramírez
48698ff2ad
📝 Add docs for using Click with Typer ( #70 )
...
* 📝 Add docs for using Click with Typer
* ✅ Add tests for integrating Click and Typer
2020-03-19 10:30:42 +01:00
Sebastián Ramírez
5a6379ffc6
✨ Add docs for testing, password, version, context. Extra tests, include callback and autocompletion PR ( #68 )
...
* ✨ Implement custom handling for callbacks with types
* ✨ Implement type-based handling for completion functions
* ✨ Add examples for custom completion
* 📝 Add docs for custom autocompletion
* ✅ Add tests for autocompletion
* ✨ Document using the context
* ✅ Add tests for using the context
* ✅ Add tests init for context
* 🔧 Update Mypy config
* ✅ Add extra tests for completion
* ✏️ Fix format, typos, and minor texts
* ✨ Update docs for printing, include stdout, stderr, and stdin
* ✏️ Add references to FastAPI, fix typos
* ✏️ Fix typo in Typer CLI
* 📝 Update docs for version
* 📝 Update docs for callbacks
* 📝 Update references to stdout/stderr in autocompletion
* 📝 Add docs for password in CLI option
* 📝 Add docs and tests for Testing
* 📝 Add new sections to docs
* 🎨 Fix formatting
2020-03-18 21:17:47 +01:00
Sebastián Ramírez
12eef051c8
🐛 Fix docs format with hl_lines ( #65 )
2020-03-12 10:46:32 +01:00
Sebastián Ramírez
96731c43be
✨ Docs for Typer CLI ( #64 )
...
* ✨ Add docs for Typer CLI
* 📝 Update references to Typer CLI in docs
* 🔧 Update tests to check files and linting before tests, to error out early
* 📝 Sync README.md with docs/index.md
2020-03-11 17:16:49 +01:00
Sebastián Ramírez
96b29e9639
✨ Add support for Click 7.1.1 ( #60 )
...
* ⬆️ Upgrade required Click to 7.1.1 and pin it to patch versions
as a MINOR version broke compatibility, so I'll have to upgrade manually every time
* 📌 Fix pinning Click to MINOR version
* ✨ Upgrade code to be compatible with latest Click changes
* ✅ Update tests with new format for errors
* 📝 Update docs to keep them in sync with actual output
2020-03-10 18:49:29 +01:00
Sebastián Ramírez
2af83b0be5
📝 Refactor docs with internal links
2020-01-18 19:35:49 +01:00
Sebastián Ramírez
fc902304b6
🎨 Tweak external link format
2020-01-17 16:27:17 +01:00
Sebastián Ramírez
5e063d8446
📝 Update docs for First Steps
2020-01-05 22:23:55 +01:00
Sebastián Ramírez
fb8622b8bb
📝 Add docs and examples for CLI parameters with multiple values
2020-01-05 22:09:41 +01:00
Sebastián Ramírez
421468c04c
📝 Add/extend docs and examples for param types. bool, int.
2020-01-05 21:52:46 +01:00
Sebastián Ramírez
56bb2576c4
📝 Add docs for callbacks and one or multiple commands
2020-01-05 21:37:44 +01:00
Sebastián Ramírez
daeb3b7656
✨ Add docs and examples for subcommands
2020-01-05 20:47:16 +01:00
Sebastián Ramírez
b36c75b5a7
✨ Add SubCommands sections
2020-01-04 02:25:02 +01:00
Sebastián Ramírez
bc4709cc9d
📝 Add docs for launching applications
2020-01-02 19:09:36 +01:00
Sebastián Ramírez
b925ed2c21
📝 Update docs for app_dir using Path
2020-01-02 19:08:53 +01:00
Sebastián Ramírez
fb46cc056c
📝 Add docs for get_app_dir()
2020-01-02 18:42:36 +01:00
Sebastián Ramírez
4f26f45134
📝 Add docs for progressbar
2020-01-02 18:17:21 +01:00
Sebastián Ramírez
541ef46319
📝 Add docs for asking with a prompt
2020-01-02 16:59:09 +01:00
Sebastián Ramírez
ff8a1e4c27
📝 Update path docs
2020-01-02 16:28:35 +01:00
Sebastián Ramírez
aadca21c0b
📝 Add docs for printing and terminating
2020-01-02 15:22:10 +01:00
Sebastián Ramírez
d8a5236c08
♻️ Refactor docs structure and add CLI option names
2020-01-02 12:49:28 +01:00
Sebastián Ramírez
073a72469c
📝 Add docs for CLI parameter types
2019-12-31 22:14:18 +01:00
Sebastián Ramírez
0ece3b9772
📝 Fix wording to avoid confusion between CLI program, command, subcommand
2019-12-30 14:24:33 +01:00
Sebastián Ramírez
b88351643d
📝 Add docs and examples for Commands
2019-12-30 14:23:31 +01:00
Sebastián Ramírez
f6b61af6ae
📝 Add docs for CLI Arguments
2019-12-29 17:08:31 +01:00
Sebastián Ramírez
345446321e
📝 Add CLI Options docs and examples
2019-12-29 10:23:31 +01:00
Sebastián Ramírez
95c1f103b3
📝 Fix typos, update docs and descriptions
2019-12-28 22:35:47 +01:00
Sebastián Ramírez
cf75cada76
📝 Update First Steps to include how to document in a docstring
2019-12-28 14:24:54 +01:00
Sebastián Ramírez
c941db5427
📝 Update docs with references to --install-completion
...
and use subcommand everywhere instead of sub-command for consistency with Click
2019-12-28 14:12:47 +01:00
Sebastián Ramírez
941e86dbe5
🐛 Make Tutorial intro be the index, to have a tutorial root
2019-12-27 00:04:19 +01:00
Sebastián Ramírez
bed4e2b0e9
✨ Update Termynal modifications, update first steps to use it
...
Make Termynal have fixed sizes, add "fast" button, use it in first steps
2019-12-27 00:02:53 +01:00
Maria Camila Gutierrez
19e86b85c5
full doc review and fixing typos
2019-12-24 20:15:16 +01:00
Sebastián Ramírez
c24269f4cd
📝 Add first version of docs
2019-12-24 13:31:59 +01:00
