MySTX 文档#
MySTX 是基于 Sphinx Book Theme 的现代化、可定制 Sphinx HTML 主题, 附带一组增强文档体验的扩展(GitHub 统计卡片、MyST 实时预览等)。 本页是文档集的根入口,承担定位与导航;各子区的事实与数字以子区
index.md为唯一权威陈述位置,本页不重复。
1. 文档地图#
区域 |
内容 |
入口 |
|---|---|---|
|
mystx 自带扩展的使用文档(指令、选项、示例) |
|
|
相关项目与插件画廊(DaoBook、Executable Books、Sphinx 扩展等) |
|
|
交互式演示(Jupyter Notebook / Thebe) |
|
|
mystx 包的 API 参考(由 autoapi 自动生成) |
构建后自动产出 |
2. 阅读路径#
按读者意图任选一条,不必从头读:
我想…… |
从这里开始 |
|---|---|
用 mystx 主题构建自己的文档 |
|
配置主题选项(仓库按钮、导航深度、页脚等) |
|
在文档里嵌入 GitHub 统计卡片 |
|
在线试写 MyST 并实时预览 |
|
查 mystx 包的 Python API |
构建产物 |
看 Sphinx 生态相关项目 |
3. 相关入口#
仓库 README(安装、特性、徽章):…/README.md
GitHub 仓库:xinetzone/mystx
上游父主题(daobook/sphinx-book-theme):https://daobook.github.io/sphinx-book-theme/