xixu-me
23dcdab305
Revised Sphinx directives in CLI and exceptions API docs to use ':no-index' instead of ':members', ':undoc-members', and ':show-inheritance'. Removed 'display_version' from Sphinx configuration. Added 'README' to the index page for better navigation.
55 lines
763 B
Markdown
55 lines
763 B
Markdown
# CLI API
|
|
|
|
The command-line interface module provides functions for the tzst CLI tool.
|
|
|
|
```{eval-rst}
|
|
.. automodule:: tzst.cli
|
|
:no-index:
|
|
```
|
|
|
|
## Main Functions
|
|
|
|
### main
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.main
|
|
```
|
|
|
|
### create_parser
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.create_parser
|
|
```
|
|
|
|
## Utility Functions
|
|
|
|
### print_banner
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.print_banner
|
|
```
|
|
|
|
### format_size
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.format_size
|
|
```
|
|
|
|
### validate_compression_level
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.validate_compression_level
|
|
```
|
|
|
|
### format_size
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.format_size
|
|
```
|
|
|
|
### validate_compression_level
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: tzst.cli.validate_compression_level
|
|
```
|