Skip to content

Commit 8b39da6

Browse files
xixu-mexixu-me
committed
Update documentation structure and metadata
Added favicon and logo to the static assets. Updated layout.html for improved SEO and performance. Migrated metadata in documentation files to use 'myst' format for consistency. Adjusted configuration in conf.py and fixed formatting issues.
1 parent b5f7fa8 commit 8b39da6

File tree

12 files changed

+82
-74
lines changed

12 files changed

+82
-74
lines changed

‎docs/_static/.gitkeep

Whitespace-only changes.

‎docs/_static/favicon.ico

48.3 KB
Binary file not shown.

‎docs/_static/tzst-logo.png

1.34 MB
Loading

‎docs/_templates/layout.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
{% extends "!layout.html" %}
1+
{% extends "!layout.html" %} {% block extrahead %} {{ super() }}
2+
<!-- Additional SEO and social meta tags -->
3+
<meta name="application-name" content="tzst" />
4+
<meta name="generator" content="Sphinx {{ sphinx_version }}" />
25

3-
{% block extrahead %}
4-
{{ super() }}
5-
<!-- Additional SEO and social meta tags -->
6-
<meta name="application-name" content="tzst">
7-
<meta name="generator" content="Sphinx {{ sphinx_version }}">
8-
9-
<!-- Schema.org markup for search engines -->
10-
<script type="application/ld+json">
6+
<!-- Schema.org markup for search engines -->
7+
<script type="application/ld+json">
118
{
129
"@context": "https://schema.org",
1310
"@type": "SoftwareApplication",
@@ -30,16 +27,19 @@
3027
"priceCurrency": "USD"
3128
}
3229
}
33-
</script>
30+
</script>
3431

35-
<!-- Canonical URL for better SEO -->
36-
{% if pagename != 'index' %}
37-
<link rel="canonical" href="https://xixu-me.github.io/tzst/{{ pagename }}.html">
38-
{% else %}
39-
<link rel="canonical" href="https://xixu-me.github.io/tzst/">
40-
{% endif %}
41-
42-
<!-- Preconnect to external domains for performance -->
43-
<link rel="preconnect" href="https://fonts.googleapis.com">
44-
<link rel="preconnect" href="https://cdnjs.cloudflare.com">
32+
<!-- Canonical URL for better SEO -->
33+
{% if pagename != 'index' %}
34+
<link
35+
rel="canonical"
36+
href="https://xixu-me.github.io/tzst/{{ pagename }}.html"
37+
/>
38+
{% else %}
39+
<link rel="canonical" href="https://xixu-me.github.io/tzst/" />
40+
{% endif %}
41+
42+
<!-- Preconnect to external domains for performance -->
43+
<link rel="preconnect" href="https://fonts.googleapis.com" />
44+
<link rel="preconnect" href="https://cdnjs.cloudflare.com" />
4545
{% endblock %}

‎docs/api/cli.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "tzst CLI API - Command-line interface functions and utilities for tar.zst archive operations"
4-
keywords: "tzst CLI API, command line interface, Python CLI, tar.zst commands"
5-
og:title: "tzst CLI API Reference"
6-
og:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
7-
twitter:title: "tzst CLI API Reference"
8-
twitter:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
2+
myst:
3+
html_meta:
4+
description: "tzst CLI API - Command-line interface functions and utilities for tar.zst archive operations"
5+
keywords: "tzst CLI API, command line interface, Python CLI, tar.zst commands"
6+
og:title: "tzst CLI API Reference"
7+
og:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
8+
twitter:title: "tzst CLI API Reference"
9+
twitter:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
910
---
1011

1112
# CLI API

‎docs/api/core.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "tzst Core API - TzstArchive class and convenience functions for tar.zst archive operations"
4-
keywords: "tzst core API, TzstArchive, Python archive class, tar.zst functions"
5-
og:title: "tzst Core API Reference"
6-
og:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
7-
twitter:title: "tzst Core API Reference"
8-
twitter:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
2+
myst:
3+
html_meta:
4+
description: "tzst Core API - TzstArchive class and convenience functions for tar.zst archive operations"
5+
keywords: "tzst core API, TzstArchive, Python archive class, tar.zst functions"
6+
og:title: "tzst Core API Reference"
7+
og:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
8+
twitter:title: "tzst Core API Reference"
9+
twitter:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
910
---
1011

1112
# Core API

‎docs/api/exceptions.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
html_meta:
3-
description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
4-
keywords: "tzst exceptions, Python exceptions, error handling, TzstError, TzstArchiveError, archive errors, compression errors"
5-
"og:title": "tzst Exceptions API Reference"
6-
"og:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
7-
"og:type": "article"
8-
"twitter:title": "tzst Exceptions API Reference"
9-
"twitter:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
10-
"article:section": "API Reference"
11-
"article:tag": "exceptions, error handling, API"
2+
myst:
3+
html_meta:
4+
description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
5+
keywords: "tzst exceptions, Python exceptions, error handling, TzstError, TzstArchiveError, archive errors, compression errors"
6+
"og:title": "tzst Exceptions API Reference"
7+
"og:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
8+
"og:type": "article"
9+
"twitter:title": "tzst Exceptions API Reference"
10+
"twitter:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
11+
"article:section": "API Reference"
12+
"article:tag": "exceptions, error handling, API"
1213
---
1314

1415
# Exceptions API

‎docs/api/index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "Complete tzst API reference - Core functions, CLI tools, and exception handling for tar.zst archives"
4-
keywords: "tzst API, Python API documentation, tar.zst API reference, archive API"
5-
og:title: "tzst API Reference"
6-
og:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
7-
twitter:title: "tzst API Reference"
8-
twitter:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
2+
myst:
3+
html_meta:
4+
description: "Complete tzst API reference - Core functions, CLI tools, and exception handling for tar.zst archives"
5+
keywords: "tzst API, Python API documentation, tar.zst API reference, archive API"
6+
og:title: "tzst API Reference"
7+
og:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
8+
twitter:title: "tzst API Reference"
9+
twitter:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
910
---
1011

1112
# API Reference

‎docs/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"og:url": "https://xixu-me.github.io/tzst/",
5252
"og:image": "https://xixu-me.github.io/tzst/_static/tzst-logo.png",
5353
"twitter:card": "summary_large_image",
54-
"twitter:title": "tzst Documentation",
54+
"twitter:title": "tzst Documentation",
5555
"twitter:description": "tzst - A Python library for creating and extracting tar.zst archives with high performance and comprehensive features",
5656
"twitter:image": "https://xixu-me.github.io/tzst/_static/tzst-logo.png",
5757
}
@@ -66,7 +66,8 @@
6666
"collapse_navigation": True,
6767
"sticky_navigation": True,
6868
"navigation_depth": 4,
69-
"includehidden": True, "titles_only": False,
69+
"includehidden": True,
70+
"titles_only": False,
7071
}
7172

7273
# Additional HTML options

‎docs/examples.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "Comprehensive tzst examples - Learn advanced archive creation, extraction, security, and performance optimization"
4-
keywords: "tzst examples, Python archive examples, tar.zst tutorials, Zstandard compression examples"
5-
og:title: "tzst Examples and Tutorials"
6-
og:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
7-
twitter:title: "tzst Examples and Tutorials"
8-
twitter:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
2+
myst:
3+
html_meta:
4+
description: "Comprehensive tzst examples - Learn advanced archive creation, extraction, security, and performance optimization"
5+
keywords: "tzst examples, Python archive examples, tar.zst tutorials, Zstandard compression examples"
6+
og:title: "tzst Examples and Tutorials"
7+
og:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
8+
twitter:title: "tzst Examples and Tutorials"
9+
twitter:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
910
---
1011

1112
# Examples

‎docs/index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "tzst - Next-generation Python library for tar.zst archives with Zstandard compression. Fast, secure, and reliable archive management."
4-
keywords: "tzst, Python, tar.zst, Zstandard, compression, archive, backup, file management"
5-
og:title: "tzst - Next-Generation Archive Management"
6-
og:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
7-
twitter:title: "tzst - Next-Generation Archive Management"
8-
twitter:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
2+
myst:
3+
html_meta:
4+
description: "tzst - Next-generation Python library for tar.zst archives with Zstandard compression. Fast, secure, and reliable archive management."
5+
keywords: "tzst, Python, tar.zst, Zstandard, compression, archive, backup, file management"
6+
og:title: "tzst - Next-Generation Archive Management"
7+
og:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
8+
twitter:title: "tzst - Next-Generation Archive Management"
9+
twitter:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
910
---
1011

1112
# tzst Documentation

‎docs/quickstart.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
html_meta:
3-
description: "Quick start guide for tzst - Learn how to install and use the Python tar.zst archive library in minutes"
4-
keywords: "tzst tutorial, Python archive tutorial, tar.zst guide, Zstandard compression guide"
5-
og:title: "tzst Quick Start Guide"
6-
og:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
7-
twitter:title: "tzst Quick Start Guide"
8-
twitter:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
2+
myst:
3+
html_meta:
4+
description: "Quick start guide for tzst - Learn how to install and use the Python tar.zst archive library in minutes"
5+
keywords: "tzst tutorial, Python archive tutorial, tar.zst guide, Zstandard compression guide"
6+
og:title: "tzst Quick Start Guide"
7+
og:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
8+
twitter:title: "tzst Quick Start Guide"
9+
twitter:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
910
---
1011

1112
# Quick Start Guide

0 commit comments

Comments
 (0)