PHPackages                             club-1/sphinx-inventory-parser - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. club-1/sphinx-inventory-parser

ActiveLibrary[Parsing & Serialization](/categories/parsing)

club-1/sphinx-inventory-parser
==============================

Parse Sphinx documentation's object.inv inventory file format into an indexed SphinxInventory object.

v1.3.0(1y ago)32961LGPL-2.1-or-laterPHPPHP >=7.4CI failing

Since Apr 2Pushed 3w ago1 watchersCompare

[ Source](https://github.com/club-1/sphinx-inventory-parser)[ Packagist](https://packagist.org/packages/club-1/sphinx-inventory-parser)[ Docs](https://github.com/club-1/sphinx-inventory-parser)[ RSS](/packages/club-1-sphinx-inventory-parser/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (4)Versions (17)Used By (1)

PHP Sphinx Inventory Parser
===========================

[](#php-sphinx-inventory-parser)

[![License LGPL-2.1-or-later](https://camo.githubusercontent.com/b0c7d9503ea964ad741c000c53cc40d0e95ace0b75aedba7a6b7b084dd4daeb1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4c47504c2d2d322e312d2d6f722d2d6c617465722d626c75652e737667)](LICENSE) [![PHP versions tested](https://camo.githubusercontent.com/24c0a7ff2bd194ef841cf03884528290e43ae04d96630b1523ff16677041a55f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d372e34253230253743253230382e30253230253743253230382e31253230253743253230382e32253230253743253230382e33253230253743253230382e342d626c75652e737667)](https://camo.githubusercontent.com/24c0a7ff2bd194ef841cf03884528290e43ae04d96630b1523ff16677041a55f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d372e34253230253743253230382e30253230253743253230382e31253230253743253230382e32253230253743253230382e33253230253743253230382e342d626c75652e737667) [![build status](https://camo.githubusercontent.com/f757a50b0033638627cf9bc828ad6c073175e80b3481dbc5ee306351f9aa6222/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f636c75622d312f737068696e782d696e76656e746f72792d7061727365722f6275696c642e796d6c2e737667)](https://github.com/club-1/sphinx-inventory-parser/actions/workflows/build.yml?query=branch%3Amain) [![coverage report](https://camo.githubusercontent.com/77ed7466bf2f7769e7dc351394b27db960fddbb66492e50a3b42b38f0ba98e7a/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f67682f636c75622d312f737068696e782d696e76656e746f72792d706172736572)](https://app.codecov.io/gh/club-1/sphinx-inventory-parser) [![docs status](https://camo.githubusercontent.com/7fae1d3da77b9c04fcfba48a3c0a714d4b6b84f0a889b206678ee3cffeb8e2e6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f636c75622d312f737068696e782d696e76656e746f72792d7061727365722f646f63732e796d6c2e7376673f6c6162656c3d646f6373)](https://club-1.github.io/sphinx-inventory-parser/)

Sphinx Inventory Parser is PHP library to parse [Sphinx documentation](https://www.sphinx-doc.org/)'s object inventory file format as used by [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html). It is loosely inspired from [sphobjinv](https://github.com/bskinn/sphobjinv), whose documentation have also been very useful by describing the [Sphinx objects.inv v2 Syntax](https://sphobjinv.readthedocs.io/en/stable/syntax.html).

Requirements
------------

[](#requirements)

The only requirement is PHP >= 7.4 with [Zlib extension](https://www.php.net/manual/en/book.zlib.php)(usually included).

Installation
------------

[](#installation)

This library is available on [packagist](https://packagist.org/packages/club-1/sphinx-inventory-parser)and can be installed via [composer](https://getcomposer.org/):

```
composer require club-1/sphinx-inventory-parser
```

Simple example
--------------

[](#simple-example)

The simplest way to use it is with `SphinxInventoryParser::parseFromDoc()`that creates a `SphinxInventory` object directly from an online documentation, based on its URL (and an optional inventory path).

```
use Club1\SphinxInventoryParser\SphinxInventoryParser;

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

For more examples on how to use this library, see [the "Usage" section](https://club-1.github.io/sphinx-inventory-parser/usage.html)of the documentation.

Documentation
-------------

[](#documentation)

See the full [documentation](https://club-1.github.io/sphinx-inventory-parser/)for more information, including the API reference.

Development
-----------

[](#development)

### Development requirements

[](#development-requirements)

- **make**: to manage build scripts
- **composer**: to install PHP development dependencies
- **pigz**: (Optional) to build tests data, will fallback to a PHP script if not present

On Debian and derivatives:

```
sudo apt install make composer pigz
```

### Build scripts

[](#build-scripts)

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

###  Health Score

39

—

LowBetter than 84% of packages

Maintenance67

Regular maintenance activity

Popularity15

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 89.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~59 days

Recently: every ~110 days

Total

9

Last Release

710d ago

Major Versions

v0.4.0 → v1.0.02023-05-07

PHP version history (2 changes)v0.1.0PHP >=7.3

v1.2.0PHP >=7.4

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/23519418?v=4)[Nicolas Peugnet](/maintainers/n-peugnet)[@n-peugnet](https://github.com/n-peugnet)

---

Top Contributors

[![n-peugnet](https://avatars.githubusercontent.com/u/23519418?v=4)](https://github.com/n-peugnet "n-peugnet (127 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (15 commits)")

---

Tags

intersphinxlibraryphpphp-librarysphinxsphinx-doc

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/club-1-sphinx-inventory-parser/health.svg)

```
[![Health](https://phpackages.com/badges/club-1-sphinx-inventory-parser/health.svg)](https://phpackages.com/packages/club-1-sphinx-inventory-parser)
```

###  Alternatives

[mck89/peast

Peast is PHP library that generates AST for JavaScript code

19139.2M45](/packages/mck89-peast)[sauladam/shipment-tracker

Parses tracking information for several carriers, like UPS, USPS, DHL and GLS by simply scraping the data. No need for any kind of API access.

9843.5k](/packages/sauladam-shipment-tracker)[jstewmc/rtf

Read and write Rich Text Format (RTF) documents with PHP

45153.1k6](/packages/jstewmc-rtf)[tcds-io/php-jackson

A lightweight, flexible object serializer for PHP, inspired by FasterXML/jackson

113.2k10](/packages/tcds-io-php-jackson)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)