Skip to content

Commit 199fe41

Browse files
committed
Update documentation references and add anchors
Updated internal references in the documentation to use simplified anchor names. Added missing anchors for sections in 'examples.md' and 'quickstart.md'. Minor formatting adjustments were also made for consistency.
1 parent 6a9a783 commit 199fe41

File tree

4 files changed

+17
-10
lines changed

4 files changed

+17
-10
lines changed

docs/404.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ The URL you requested could not be found in the tzst documentation. This might h
3131

3232
### Quick Navigation
3333

34-
- **Installation Guide** - {ref}`quickstart:installation`
35-
- **Basic Usage** - {ref}`quickstart:basic-usage`
36-
- **Security Features** - {ref}`examples:security-and-filtering`
37-
- **Error Handling** - {ref}`examples:error-handling`
34+
- **Installation Guide** - {ref}`installation`
35+
- **Basic Usage** - {ref}`basic-usage`
36+
- **Security Features** - {ref}`security-and-filtering`
37+
- **Error Handling** - {ref}`error-handling`
3838

3939
## 🔎 Search Documentation
4040

@@ -48,10 +48,10 @@ Use the search box in the top navigation to find what you're looking for, or bro
4848

4949
### Examples & Tutorials
5050

51-
- **Archive Creation** - {ref}`examples:basic-archive-operations`
52-
- **Security Best Practices** - {ref}`examples:security-and-filtering`
53-
- **Integration Examples** - {ref}`examples:integration-examples`
54-
- **Performance Optimization** - {ref}`quickstart:performance-optimization`
51+
- **Archive Creation** - {ref}`basic-archive-operations`
52+
- **Security Best Practices** - {ref}`security-and-filtering`
53+
- **Integration Examples** - {ref}`integration-examples`
54+
- **Performance Optimization** - {ref}`performance-optimization`
5555

5656
## 📚 Additional Resources
5757

docs/examples.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ This section provides comprehensive examples of using tzst for various scenarios
2828

2929
## Basic Operations
3030

31+
(basic-archive-operations)=
32+
3133
### Creating Your First Archive
3234

3335
```python

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ quickstart
2121
api/index
2222
examples
2323
README
24+
404
2425
```
2526

2627
## What is tzst?

docs/quickstart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ myst:
1313

1414
This guide will get you up and running with tzst in just a few minutes.
1515

16+
(installation)=
17+
1618
## Installation
1719

1820
Choose your preferred installation method:
@@ -46,6 +48,8 @@ cd tzst
4648
pip install .
4749
```
4850

51+
(basic-usage)=
52+
4953
## Basic Usage
5054

5155
### Command Line Interface
@@ -185,11 +189,11 @@ extract_archive("trusted.tzst", "output/", filter="tar")
185189
from tzst import extract_archive, ConflictResolution
186190

187191
# Skip existing files
188-
extract_archive("archive.tzst", "output/",
192+
extract_archive("archive.tzst", "output/",
189193
conflict_resolution=ConflictResolution.SKIP_ALL)
190194

191195
# Auto-rename conflicting files
192-
extract_archive("archive.tzst", "output/",
196+
extract_archive("archive.tzst", "output/",
193197
conflict_resolution=ConflictResolution.AUTO_RENAME_ALL)
194198
```
195199

0 commit comments

Comments
 (0)