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

994 B

Raw Blame History

API Reference

This section contains the complete API documentation for tzst.

:maxdepth: 2

core
cli
exceptions

Overview

The tzst library provides both high-level convenience functions and a comprehensive class-based API for working with .tzst/.tar.zst archives.

Main Components

{doc}core: Core functionality including TzstArchive class and convenience functions
{doc}cli: Command-line interface functions and utilities
{doc}exceptions: Custom exception classes for error handling

Quick Reference

Core Classes

.. currentmodule:: tzst

.. autosummary::
   :nosignatures:
   
   TzstArchive

Convenience Functions

.. autosummary::
   :nosignatures:
   
   create_archive
   extract_archive
   list_archive
   test_archive

Exceptions

.. currentmodule:: tzst.exceptions

.. autosummary::
   :nosignatures:
   
   TzstArchiveError
   TzstDecompressionError

994 B Raw Blame History