Skip to main content

xyzstyle

PyPI GitHub issues GitHub forks GitHub stars GitHub license contributors Documentation Status Downloads PyPI - Downloads

xyzstyle 是基于 Sphinx Book Theme 的现代化、可定制的 Sphinx HTML 主题,为技术文档提供优雅美观的展示效果。它结合了现代Web设计理念与优秀的阅读体验,使您的文档既专业又易于阅读。

主要特点

  • 主题继承:完美继承并扩展 sphinx_book_theme 的功能
  • 配置管理:支持通过 TOML 文件加载和管理配置
  • 事件集成:与 Sphinx 的配置初始化事件无缝集成
  • 样式定制:提供自定义 CSS 文件和主题选项
  • 响应式设计:适配桌面和移动设备的响应式布局

项目结构

src/xyzstyle/
├── __init__.py          # Sphinx 扩展入口点
├── set_theme.py         # 主题管理类
└── theme/xyzstyle/      # 主题资源文件
    ├── theme.toml       # 主题配置
    ├── layout.html      # 主题布局模板
    └── static/          # 静态资源文件
        ├── css/         # CSS 样式文件
        └── js/          # JavaScript 文件

安装

使用 pip 安装 XYZStyle 主题:

pip install xyzstyle

依赖

  • sphinx_book_theme (主题继承)
  • Sphinx (文档生成引擎)
  • Python 3.12+ (运行环境)

配置文件加载

XYZStyle 支持通过在 Sphinx 项目源码目录中的 default.toml 文件加载 html_theme_options 等配置。

Release files for xyzstyle 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xyzstyle 0.2.0
File Size Uploaded
xyzstyle-0.2.0.tar.gz 20.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for xyzstyle 0.2.0
File Interpreter ABI Platform
xyzstyle-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 40.4 kB

Release files / xyzstyle-0.2.0.tar.gz

Download URL xyzstyle-0.2.0.tar.gz
Size 20.0 kB
Tags Source
SHA-256 checksum
How to use checksums
02be60b263338c7540da1e6ec644d711834a55f3c353ce64307c66a74ad37345
BLAKE2b-256 checksum
How to use checksums
92f4f262777f7506adfeabf1c9c8eab03a6af8c9eafb11ef5183565bdb313860
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / xyzstyle-0.2.0-py3-none-any.whl

Download URL xyzstyle-0.2.0-py3-none-any.whl
Size 20.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
842b124d90c4af16918044e9bd3fd9cfcd407d7c0587ddaf16f455a44c667a45
BLAKE2b-256 checksum
How to use checksums
db8cb3a24143ed5e503ac1e4ab9f1d02f0ac59b63ee66400a0c1fdaee8af87eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page