Commit Graph
129 Commits
Author SHA1 Message Date
xixu-me 8b39da60da 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.
2025-06-06 18:34:17 +08:00
xixu-me b5f7fa8dca Enhance documentation with SEO metadata and layout
Added a new custom layout template for SEO and social media meta tags. Updated multiple documentation files with metadata for improved search engine optimization and social sharing. Enhanced Sphinx configuration with additional HTML options and meta tags.
2025-06-06 17:50:43 +08:00
xixu-me abbeab83f1 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.
2025-06-06 17:39:15 +08:00
xixu-me ef5d06cb0e Enhance documentation for tzst library
- Updated the introduction to provide a clearer overview of tzst's capabilities and features.
- Expanded the Key Features section with detailed descriptions and icons for better readability.
- Improved the Quick Example section to include both command line and Python API usage.
- Added installation options with detailed steps for PyPI, standalone binaries, and source installation.
- Enhanced the Quick Start Guide with structured installation methods and basic usage examples.
- Introduced advanced features like security filters, conflict resolution, and performance optimization.
- Provided comprehensive error handling and common patterns for backup scripts and archive verification.
- Updated the requirements and reference links for better navigation.
2025-06-06 17:31:08 +08:00
xixu-me d0e09347eb Update documentation URL in CLI script
Replaced the outdated GitHub README URL with the new documentation URL (https://tzst.xi-xu.me) in the CLI script for better reference.
2025-06-06 16:23:25 +08:00
xixu-me 76e56c984f Update Sphinx build ignore rules
Removed '_static/' from .gitignore to allow tracking of the '_static' directory. Added a .gitkeep file in '_static' to ensure the directory is included in the repository.
2025-06-06 16:05:45 +08:00
xixu-me d3e5b4e064 Remove duplicate CLI function documentation
Eliminated redundant sections for `format_size` and `validate_compression_level` in the CLI documentation to improve clarity and avoid repetition.
2025-06-06 16:04:34 +08:00
xixu-me 23dcdab305 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.
2025-06-06 15:47:38 +08:00
xixu-me 2777fea4fc Add linkify-it-py to documentation requirements
Added the linkify-it-py package (version 2.0.0 or higher) to the docs/requirements.txt file to support automatic linkification in the documentation.
2025-06-06 15:26:27 +08:00
xixu-me 2ca81e0918 Update docs workflow and improve documentation scripts
Modified the GitHub Actions workflow to trigger on push and pull requests to the main branch. Updated `.gitignore` to include additional Sphinx build outputs. Refactored `build_docs.py` for better formatting and error handling. Removed 'changelog' from the documentation index.
2025-06-06 15:15:52 +08:00
xixu-me eb3f66f85e Update README.zh.md 2025-06-06 00:23:20 +08:00
xixu-me 028c7e3650 Update README.ru.md 2025-06-06 00:23:06 +08:00
xixu-me 9e5a677155 Update README.pt.md 2025-06-06 00:22:55 +08:00
xixu-me 19356b819f Update README.md 2025-06-06 00:22:43 +08:00
xixu-me bac2f44072 Update README.ko.md 2025-06-06 00:22:30 +08:00
xixu-me ffb6981965 Update README.ja.md 2025-06-06 00:22:19 +08:00
xixu-me 15d0828fae Update README.fr.md 2025-06-06 00:22:08 +08:00
xixu-me 710c22f605 Update README.es.md 2025-06-06 00:21:55 +08:00
xixu-me 7c268be215 Update README.de.md 2025-06-06 00:21:32 +08:00
xixu-me b92b5c8652 Update README.ar.md 2025-06-06 00:21:18 +08:00
xixu-me af0159a9fe Update language links in README files
Replaced '🇬🇧 English' with 'us English' in all README files and standardized placeholder text for version numbers in the Arabic README. These changes improve consistency across documentation.
2025-06-05 15:29:12 +08:00
xixu-me f6d1ff631d Add Portuguese, Russian, etc. translations for README files 2025-06-05 12:19:39 +08:00
xixu-me b5a654c187 Update README.zh.md 2025-06-05 10:34:33 +08:00
xixu-me 9b30a8657c Update README.ko.md 2025-06-05 02:05:03 +08:00
xixu-me 7f2e53c9d0 Create README.ko.md 2025-06-05 02:03:47 +08:00
xixu-me 58400c8f42 Update README.ja.md 2025-06-05 01:51:28 +08:00
xixu-me cd56764f84 Update README.ja.md 2025-06-05 00:55:16 +08:00
xixu-me 8b3e4d2429 Create README.ja.md 2025-06-05 00:54:04 +08:00
xixu-me 22a879a002 Update README.es.md 2025-06-05 00:51:21 +08:00
xixu-me ac14a4bca7 Create README.es.md 2025-06-05 00:42:39 +08:00
xixu-me f89a10ec50 Update README.zh.md 2025-06-05 00:31:31 +08:00
xixu-me 518e90f0ee Create README.zh.md 2025-06-05 00:03:31 +08:00
xixu-me 194037b87c Update README.md 2025-06-05 00:01:14 +08:00
xixu-me 47d6504f39 Update README.md 2025-06-04 22:33:38 +08:00
xixu-me a15a497c52 Update PyPI badge and README formatting
Modified the PyPI version badge URL in the CI workflow and README to simplify the URL. Enhanced README with emojis for better visual appeal and added detailed installation instructions for standalone binaries.
2025-06-04 22:16:41 +08:00
xixu-me f866f30b7e Bump version to 1.2.3
CI/CD / test (macos-latest, 3.12) (push) Waiting to run
CI/CD / test (macos-latest, 3.13) (push) Waiting to run
CI/CD / test (ubuntu-latest, 3.12) (push) Waiting to run
CI/CD / test (ubuntu-latest, 3.13) (push) Waiting to run
CI/CD / test (windows-latest, 3.12) (push) Waiting to run
CI/CD / test (windows-latest, 3.13) (push) Waiting to run
Updated the `__version__` in `__init__.py` from 1.2.2 to 1.2.3 to reflect the latest changes or release.
v1.2.3
2025-06-04 21:39:18 +08:00
xixu-me b2eebdedb2 Simplify GitHub release notes in CI workflow
Updated the GitHub release creation step to use a simplified title format and removed detailed release notes. This change streamlines the release process by omitting installation instructions and commit history links.
2025-06-04 21:39:02 +08:00
xixu-me 1414138341 Update badges [skip ci] 2025-06-04 13:29:39 +00:00
xixu-me eb4d29e503 Bump version to 1.2.2
Updated the `__version__` in `__init__.py` from 1.2.1 to 1.2.2 to reflect the latest changes or release.
2025-06-04 21:27:09 +08:00
xixu-me 76963aaf9f Fix indentation in CI workflow script
Corrected the indentation in the Python script within the CI workflow to ensure proper execution of the version assignment and file writing logic.
2025-06-04 21:26:38 +08:00
xixu-me 8035a77c10 Bump version to 1.2.1
Updated the `__version__` in `__init__.py` from 1.2.0 to 1.2.1 to reflect the latest changes or release.
2025-06-04 21:18:57 +08:00
xixu-me d95f173308 Update PyInstaller command in CI workflow
Modified the PyInstaller command in the CI configuration to specify 'src/main.py' as the entry point for building binaries across macOS, Windows, and Linux ARM64 platforms.
2025-06-04 21:12:43 +08:00
xixu-me 637f1d2562 Update CI workflow and add main entry point
Modified the CI workflow to correctly specify the path to the main script for PyInstaller builds. Added a new standalone entry point in src/main.py to serve as the executable script for tzst.
2025-06-04 21:08:33 +08:00
xixu-me d2f11636be Revert "Add standalone entry point for tzst"
This reverts commit 69918b4be5.
2025-06-04 21:05:15 +08:00
xixu-me 69918b4be5 Add standalone entry point for tzst
Created a new main.py file as the standalone entry point for tzst, intended for PyInstaller builds. This script sets up the Python path and invokes the CLI main function.
2025-06-04 21:04:24 +08:00
xixu-me 7d688d420b Bump version to 1.2.0
Updated the `__version__` in `__init__.py` to reflect the new release version 1.2.0.
2025-06-04 20:54:49 +08:00
xixu-me 56a10bc038 Update CI workflow for macOS and binary verification
This commit updates the CI workflow to use macOS-14 for ARM-based runners, adds binary verification steps for Linux, macOS, and Windows, and improves release asset upload handling with success checks. Additionally, it refines the README badge update process for PyPI version.
2025-06-04 20:54:31 +08:00
xixu-me 1dd3cde654 Enhance CI/CD workflow for versioned tags
Updated the CI/CD pipeline to support versioned tags for releases. Added new jobs for building binaries across multiple platforms and architectures, creating release assets, and uploading them to GitHub. Improved conditional logic for triggering workflows based on tags and streamlined badge updates.
2025-06-04 20:42:48 +08:00
xixu-me a1de2e1855 Remove unused report configuration in Codecov
The 'report.exclude_labels' section was removed from the Codecov configuration as it is no longer needed. This simplifies the configuration file.
2025-06-04 20:06:18 +08:00
xixu-me 6397968a4d Improve conflict resolution in archive extraction
Updated the `extract_archive` function to handle string-based conflict resolution by converting it to an enum. Added fallback to `ConflictResolution.REPLACE` for invalid values, ensuring safer and more predictable behavior.
2025-06-04 19:27:41 +08:00