sphinx-to-sqlite 作者:simonw

标星

README 源代码

sphinx-to-sqlite

PyPI Changelog Tests License

从 Sphinx 文档创建 SQLite 数据库。

演示

您可以在 https://latest-docs.datasette.io/docs/sections 查看对 Datasette 文档 运行此工具的结果。

安装

使用 pip 安装此工具

$ pip install sphinx-to-sqlite

用法

首先运行 sphinx-build 命令并带上 -b xml 选项,以便在您的 _build/ 目录中创建 XML 文件。

然后运行

$ sphinx-to-sqlite docs.db path/to/_build

以构建 SQLite 数据库。

开发

要为此工具做贡献,请先检出代码。然后创建一个新的虚拟环境

cd sphinx-to-sqlite
python -mvenv venv
source venv/bin/activate

或者如果您正在使用 pipenv

pipenv shell

现在安装依赖和测试

pip install -e '.[test]'

运行测试

pytest