Skip to content

Commit abbeab8

Browse files
committed
Update documentation with indexing and references
Added the ':no-index:' directive to CLI, core, and exceptions API documentation to exclude them from indexing. Updated examples documentation to use Sphinx references for better navigation and added section anchors for improved structure.
1 parent ef5d06c commit abbeab8

File tree

4 files changed

+27
-8
lines changed

4 files changed

+27
-8
lines changed

docs/api/cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The command-line interface module provides comprehensive functionality for the t
77
:members:
88
:undoc-members:
99
:show-inheritance:
10+
:no-index:
1011
```
1112

1213
## Overview

docs/api/core.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The core module provides the main functionality for working with tzst archives,
77
:members:
88
:undoc-members:
99
:show-inheritance:
10+
:no-index:
1011
```
1112

1213
## TzstArchive Class

docs/api/exceptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Custom exception classes used by tzst for comprehensive error handling and debug
77
:members:
88
:undoc-members:
99
:show-inheritance:
10+
:no-index:
1011
```
1112

1213
## Overview

docs/examples.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ This section provides comprehensive examples of using tzst for various scenarios
44

55
## Table of Contents
66

7-
- [Basic Operations](#basic-operations)
8-
- [Advanced Archive Creation](#advanced-archive-creation)
9-
- [Flexible Extraction](#flexible-extraction)
10-
- [Security and Filtering](#security-and-filtering)
11-
- [Performance Optimization](#performance-optimization)
12-
- [Error Handling](#error-handling)
13-
- [Real-World Scenarios](#real-world-scenarios)
14-
- [Integration Examples](#integration-examples)
7+
- {ref}`basic-operations`
8+
- {ref}`advanced-archive-creation`
9+
- {ref}`flexible-extraction`
10+
- {ref}`security-and-filtering`
11+
- {ref}`performance-optimization`
12+
- {ref}`error-handling`
13+
- {ref}`real-world-scenarios`
14+
- {ref}`integration-examples`
15+
16+
(basic-operations)=
1517

1618
## Basic Operations
1719

@@ -125,6 +127,8 @@ tzst t backup.tzst
125127
tzst l huge-archive.tzst --streaming
126128
```
127129

130+
(advanced-archive-creation)=
131+
128132
## Advanced Archive Creation
129133

130134
### Working with the TzstArchive Class
@@ -198,6 +202,8 @@ create_archive("important-data.tzst", ["critical/"], use_temp_file=True)
198202
create_archive("temp-data.tzst", ["temp/"], use_temp_file=False)
199203
```
200204

205+
(flexible-extraction)=
206+
201207
## Flexible Extraction
202208

203209
### Extracting with Different Structures
@@ -272,6 +278,8 @@ def extract_large_files_only(archive_path, output_dir, min_size_mb=10):
272278
extract_large_files_only("mixed-content.tzst", "large-files/", min_size_mb=5)
273279
```
274280

281+
(security-and-filtering)=
282+
275283
## Security and Filtering
276284

277285
### Safe Extraction Practices
@@ -365,6 +373,8 @@ extract_archive("archive.tzst", "output/",
365373
interactive_callback=custom_conflict_handler)
366374
```
367375

376+
(performance-optimization)=
377+
368378
## Performance Optimization
369379

370380
### Streaming for Large Archives
@@ -465,6 +475,8 @@ file_groups = {
465475
create_archive_batch(file_groups)
466476
```
467477

478+
(error-handling)=
479+
468480
## Error Handling
469481

470482
### Comprehensive Error Handling
@@ -571,6 +583,8 @@ def validate_and_repair_archive(archive_path):
571583
validate_and_repair_archive("potentially-corrupted.tzst")
572584
```
573585

586+
(real-world-scenarios)=
587+
574588
## Real-World Scenarios
575589

576590
### Automated Backup System
@@ -882,6 +896,8 @@ if __name__ == "__main__":
882896
)
883897
```
884898

899+
(integration-examples)=
900+
885901
## Integration Examples
886902

887903
### Django Management Command

0 commit comments

Comments
 (0)