PHPackages                             matthiasnoback/sphinx-documentation-collector - 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. [Utility & Helpers](/categories/utility)
4. /
5. matthiasnoback/sphinx-documentation-collector

ActiveLibrary[Utility & Helpers](/categories/utility)

matthiasnoback/sphinx-documentation-collector
=============================================

A tool for collecting documentation roots from different libraries

v0.1.0(12y ago)06.0kMITPHP

Since Mar 22Pushed 11y ago1 watchersCompare

[ Source](https://github.com/matthiasnoback/sphinx-documentation-collector)[ Packagist](https://packagist.org/packages/matthiasnoback/sphinx-documentation-collector)[ Docs](http://github.com/matthiasnoback/sphinx-documentation-collector)[ RSS](/packages/matthiasnoback-sphinx-documentation-collector/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (5)Versions (2)Used By (0)

Sphinx documentation collector
==============================

[](#sphinx-documentation-collector)

This library provides a tool for collecting different documentation roots from all over your project and combine them into one table of contents file, which will be your project documentation.

Installing Sphinx
-----------------

[](#installing-sphinx)

- Install Python if necessary (at least version 2.6)
- Install the `easy_install` for Python eggs ()
- Run `easy_install sphinx`

### Enable PDF

[](#enable-pdf)

- Run `easy_install rst2pdf` (more about that on )
- Configure Sphinx and `rst2pdf` ()

### For PHP and/or Symfony-related documentation

[](#for-php-andor-symfony-related-documentation)

Install Sphinx PHP extensions by Fabien Potencier () using Composer:

```
composer require --dev fabpot/sphinx-php:1.*

```

Then add the extensions:

```
# in config.py

import sys

...

sys.path.insert(0, os.path.abspath('../../vendor/fabpot/sphinx-php'))

extensions = [..., 'sensio.sphinx.refinclude', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode']

```

Configure the PHP lexer to work for code samples without a PHP open tag:

```
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# enable highlighting for PHP code not between ```` by default
lexers['php'] = PhpLexer(startinline=True)
lexers['php-annotations'] = PhpLexer(startinline=True)

primary_domain = 'php'

# API URL
api_url = 'http://api.symfony.com/master/%s'

```

Usage
-----

[](#usage)

```
php bin/collect.php build/documentation --library-dir=src/Acme/*/ --library-dir=vendor/acme/*/

```

The first argument should be the Sphinx documentation directory. Then you need to supply one or more `--library-dir`options. Those will be used to scan for `/meta/doc` directories containing an `index.rst` file. For each of these "documentation roots" a symlink will be created in the build directory. Finally a fresh table of contents is automatically generated: it collects all the `index.rst` files from all over the project.

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

4436d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1193078?v=4)[Matthias Noback](/maintainers/matthiasnoback)[@matthiasnoback](https://github.com/matthiasnoback)

---

Top Contributors

[![matthiasnoback](https://avatars.githubusercontent.com/u/1193078?v=4)](https://github.com/matthiasnoback "matthiasnoback (5 commits)")

---

Tags

documentationsphinx

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/matthiasnoback-sphinx-documentation-collector/health.svg)

```
[![Health](https://phpackages.com/badges/matthiasnoback-sphinx-documentation-collector/health.svg)](https://phpackages.com/packages/matthiasnoback-sphinx-documentation-collector)
```

###  Alternatives

[symfony/maker-bundle

Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.

3.4k111.1M568](/packages/symfony-maker-bundle)[symplify/monorepo-builder

Not only Composer tools to build a Monorepo.

5205.3M82](/packages/symplify-monorepo-builder)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k20](/packages/civicrm-civicrm-core)[friendsoftypo3/content-blocks

TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML

96374.6k23](/packages/friendsoftypo3-content-blocks)[nativephp/desktop

NativePHP for Desktop

34020.6k3](/packages/nativephp-desktop)[solspace/craft-freeform

The most flexible and user-friendly form building plugin!

52664.9k12](/packages/solspace-craft-freeform)

PHPackages © 2026

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