diff --git a/docs/api/cli.md b/docs/api/cli.md index ea0b90d..5a7a12b 100644 --- a/docs/api/cli.md +++ b/docs/api/cli.md @@ -4,9 +4,7 @@ The command-line interface module provides functions for the tzst CLI tool. ```{eval-rst} .. automodule:: tzst.cli - :members: - :undoc-members: - :show-inheritance: + :no-index: ``` ## Main Functions @@ -42,3 +40,15 @@ The command-line interface module provides functions for the tzst CLI tool. ```{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 +``` diff --git a/docs/api/exceptions.md b/docs/api/exceptions.md index 9e18785..e1b31e2 100644 --- a/docs/api/exceptions.md +++ b/docs/api/exceptions.md @@ -4,9 +4,7 @@ Custom exception classes used by tzst. ```{eval-rst} .. automodule:: tzst.exceptions - :members: - :undoc-members: - :show-inheritance: + :no-index: ``` ## Exception Hierarchy diff --git a/docs/conf.py b/docs/conf.py index d26e38f..b1df13a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,7 +39,6 @@ html_short_title = "tzst" html_theme_options = { "canonical_url": "https://xixu-me.github.io/tzst/", "logo_only": False, - "display_version": True, "prev_next_buttons_location": "bottom", "style_external_links": False, "style_nav_header_background": "#2980B9", diff --git a/docs/index.md b/docs/index.md index 4b45af4..d6ebaab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,7 @@ Welcome to **tzst**, the next-generation Python library engineered for modern ar quickstart api/index examples +README ``` ## What is tzst?