Update documentation structure and configuration
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.
This commit is contained in:
1 parent
2777fea4fc
commit
23dcdab305
4 files changed
+15
-7
No files matched your search
+13
-3
@@ -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
|
||||
```
|
||||
@@ -4,9 +4,7 @@ Custom exception classes used by tzst.
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: tzst.exceptions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:no-index:
|
||||
```
|
||||
|
||||
## Exception Hierarchy
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -9,6 +9,7 @@ Welcome to **tzst**, the next-generation Python library engineered for modern ar
|
||||
quickstart
|
||||
api/index
|
||||
examples
|
||||
README
|
||||
```
|
||||
|
||||
## What is tzst?
|
||||
|
||||
Reference in new issue
Block a user