Zzzeek的Sphinx布局和工具。
项目描述
这是zzzeek自己的Sphinx布局，由SQLAlchemy使用。
此布局首先用于SQLAlchemy文档构建（以及可能的其他相关项目）。
功能包括
使用Mako模板而不是Jinja，以在模板内提供更多编程能力。
布局包括一个可以独立滚动的侧边栏
一个独特的（针对Sphinx）的“上下文”侧边栏内容，它显示当前页面与其所有同级页面的上下文（如MySQL文档）。这是一种TOC，Sphinx通常没有很多能力做到（虽然它可以通过添加一些简单功能来实现），但在我看来，这种导航对于非常大的嵌套文档集至关重要，因此导航栏保持相对较小，同时提供文档中的位置和本地可用内容的上下文。
对autodoc的修改，用于说明继承类、基类和方法文档，说明方法是否仅从基类继承或覆盖。
一个“动态基”功能，在ReadTheDocs下，将从您选择的网站上拉取可选的.mako和.py文件，分别作为替代基模板和额外的配置设置源，允许布局在网页上查看时集成到外部网站的布局中。
一个“viewsource”扩展，可以为任意Python文件提供高亮显示的源代码。
SQLAlchemy特定内容，如[SQL]弹出窗口、方言信息指令。
使用pyscss支持scss。
配置
在conf.py中，扩展是
extensions = [
'zzzeeksphinx',
]
主题是
html_theme = 'zzzeeksphinx'
SQLAlchemy已设置的其它配置；这两个可能需要
# The short X.Y version. version = "1.0" # The full version, including alpha/beta/rc tags. release = "1.0.0" release_date = "Not released"
为“动态站点功能”的额外配置看起来像
site_base = os.environ.get("RTD_SITE_BASE", "https://sqlalchemy.org.cn")
site_adapter_template = "docs_adapter.mako"
site_adapter_py = "docs_adapter.py"
在运行autodoc以显示API文档时，对模块名称进行最后时刻翻译的配置
autodocmods_convert_modname = {
"sqlalchemy.sql.sqltypes": "sqlalchemy.types",
"sqlalchemy.sql.type_api": "sqlalchemy.types",
"sqlalchemy.sql.schema": "sqlalchemy.schema",
"sqlalchemy.sql.elements": "sqlalchemy.sql.expression",
"sqlalchemy.sql.selectable": "sqlalchemy.sql.expression",
"sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
"sqlalchemy.sql.ddl": "sqlalchemy.schema",
"sqlalchemy.sql.base": "sqlalchemy.sql.expression"
}
autodocmods_convert_modname_w_class = {
("sqlalchemy.engine.interfaces", "Connectable"): "sqlalchemy.engine",
("sqlalchemy.sql.base", "DialectKWArgs"): "sqlalchemy.sql.base",
}
关闭
zzzeeksphinx-1.5.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | aeeb6f9db316503708373c5a8fc06256cb601ee4f6855867e158fc13a0ec377a |
|
| MD5 | 9f821a1fa3a156dd1a4a6c0f4677de50 |
|
| BLAKE2b-256 | a46f5a0499185d0d7ffc3b94d187f52f8e8cf233ae525eff304631980e3a3d63 |