xixu-me/tzst

0 Fork 0

Files

T

xixu-me cfb8290dea Add comprehensive Sphinx documentation with GitHub Pages deployment

- Complete documentation structure with index, quickstart, examples, and API reference
- Sphinx configuration with RTD theme, MyST parser, and autodoc
- GitHub Actions workflow for automated documentation building and deployment
- Local development tools (Makefile, build scripts)
- Comprehensive examples covering basic usage, security, and performance
- API documentation for core, CLI, and exceptions modules

2025-06-02 21:11:45 +08:00

808 B

Raw Blame History

Core API

The core module provides the main functionality for working with tzst archives.

.. automodule:: tzst.core
   :members:
   :undoc-members:
   :show-inheritance:

TzstArchive Class

The main class for handling .tzst/.tar.zst archives.

.. autoclass:: tzst.TzstArchive
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__, __enter__, __exit__

Convenience Functions

High-level functions for common archive operations.

create_archive

.. autofunction:: tzst.create_archive

extract_archive

.. autofunction:: tzst.extract_archive

list_archive

.. autofunction:: tzst.list_archive

test_archive

.. autofunction:: tzst.test_archive

808 B Raw Blame History