club-1/sphinx-inventory-parser

将 Sphinx 文档的 object.inv 库存文件格式解析为索引 SphinxInventory 对象。

维护者

详细信息

github.com/club-1/sphinx-inventory-parser

主页

源代码

问题

文档

安装: 233

依赖项: 1

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

v1.3.0 2024-07-22 13:38 UTC

Requires

Requires (Dev)

LGPL-2.1-or-later 3767d09711f79ffa4d6ef34dace72e65bbbebcaf

  • Nicolas Peugnet <nicolas.woop@club1.fr>

This package is auto-updated.

Last update: 2024-09-28 00:31:12 UTC

README

License LGPL-2.1-or-later PHP versions tested build status coverage report docs status

Sphinx Inventory Parser 是一个 PHP 库，用于解析Sphinx 文档的 object inventory 文件格式，该格式由intersphinx使用。它受到了sphobjinv的启发，sphobjinv 的文档也非常有用，因为它描述了Sphinx objects.inv v2 语法。

要求

唯一的要求是 PHP >= 7.4，并安装 Zlib 扩展（通常已包含）。

安装

此库可在 packagist 上找到，并且可以通过 composer 进行安装。

composer require club-1/sphinx-inventory-parser

简单示例

使用它的最简单方法是使用 SphinxInventoryParser::parseFromDoc()，它可以直接从在线文档创建一个 SphinxInventory 对象，基于其 URL（以及可选的库存路径）。

use Club1\SphinxInventoryParser\SphinxInventoryParser;

$inventory = SphinxInventoryParser::parseFromDoc('https://club1.fr/docs/fr/');

有关如何使用此库的更多示例，请参阅文档的"使用"部分。

文档

有关更多信息，包括 API 参考，请参阅完整的文档。

开发

开发要求

  • make：用于管理构建脚本
  • composer：用于安装 PHP 开发依赖
  • pigz：（可选）用于构建测试数据，如果不存在，将回退到 PHP 脚本

在 Debian 和其衍生版本上

sudo apt install make composer pigz

构建脚本

make        # Fetch development dependencies and build tests data.
make check  # Run tests.
make fuzz   # Run fuzzer.
make clean  # Clean all downloaded and generated files.