PHPackages                             neos/doctools - 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. neos/doctools

ActiveNeos-package[Utility & Helpers](/categories/utility)

neos/doctools
=============

Tools for generating and rendering Flow and Neos documentation

4.2.0(1y ago)18.5k4MITPHPPHP ^8.0

Since Mar 25Pushed 1y ago4 watchersCompare

[ Source](https://github.com/neos/doctools)[ Packagist](https://packagist.org/packages/neos/doctools)[ Fund](https://shop.neos.io/neosfunding/)[ RSS](/packages/neos-doctools/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (28)Used By (0)

Neos.DocTools Documentation
===========================

[](#neosdoctools-documentation)

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

[](#requirements)

We need *Sphinx* () to render documentation. So in case you want to create HTML documentation from the files generated by this package, you can use the following command to install it:

```
pip install -U sphinx

```

Or read the official documentation for more installation methods.

References
----------

[](#references)

The DocTools package can also generate references based on source code. An example for that is the FluidAdaptor ViewHelper reference in the Flow documentation. The process is configured like this:

```
Neos:
  DocTools:
    references:
      FluidAdaptorViewHelpers:
        title: 'FluidAdaptor ViewHelper Reference'
        savePathAndFilename: '%FLOW_PATH_PACKAGES%Framework/Neos.Flow/Documentation/TheDefinitiveGuide/PartV/FluidAdaptorViewHelperReference.rst'
        affectedClasses:
          parentClassName: 'Neos\FluidAdaptor\Core\ViewHelper\AbstractViewHelper'
          classNamePattern: '/^Neos\\FluidAdaptor\\ViewHelpers\\.*$/i'
        parser:
          implementationClassName: 'Neos\DocTools\Domain\Service\FluidViewHelperClassParser'
          options:
            namespaces:
              f: 'Neos\FluidAdaptor\ViewHelpers'
```

A reference can be generated by the following command::

```
./flow reference:render [--reference ]

```

Command References
------------------

[](#command-references)

The DocTools package can also generate CLI command references. The process is configured like this:

```
Neos:
  DocTools:
    commandReferences:
      'Flow:FlowCommands':
        title: 'Flow Command Reference'
        packageKeys:
          - 'Neos.Flow'
          - 'Neos.Party'
          - 'Neos.FluidAdaptor'
          - 'Neos.Kickstart'
          - 'Neos.Welcome'
        savePathAndFilename: '%FLOW_PATH_PACKAGES%Framework/Neos.Flow/Documentation/TheDefinitiveGuide/PartV/CommandReference.rst'
```

A reference can be generated by the following command:

```
./flow commandreference:render [--reference ]

```

###  Health Score

45

—

FairBetter than 93% of packages

Maintenance43

Moderate activity, may be stable

Popularity26

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity78

Established project with proven stability

 Bus Factor1

Top contributor holds 61.8% 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 ~138 days

Recently: every ~222 days

Total

27

Last Release

467d ago

Major Versions

1.0.2 → 2.0.52015-06-15

1.0.3 → 2.0.62015-07-16

1.0.4 → 2.0.72017-03-29

2.0.7 → 3.0.02017-03-29

3.3.1 → 4.0.02022-09-02

PHP version history (2 changes)4.0.0PHP ^7.4 || ^8.0

4.2.0PHP ^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/11575267?v=4)[Neos](/maintainers/neos)[@neos](https://github.com/neos)

---

Top Contributors

[![kdambekalns](https://avatars.githubusercontent.com/u/95873?v=4)](https://github.com/kdambekalns "kdambekalns (160 commits)")[![skurfuerst](https://avatars.githubusercontent.com/u/190777?v=4)](https://github.com/skurfuerst "skurfuerst (48 commits)")[![robertlemke](https://avatars.githubusercontent.com/u/95582?v=4)](https://github.com/robertlemke "robertlemke (20 commits)")[![skorpi](https://avatars.githubusercontent.com/u/1339951?v=4)](https://github.com/skorpi "skorpi (6 commits)")[![albe](https://avatars.githubusercontent.com/u/4259532?v=4)](https://github.com/albe "albe (5 commits)")[![dfeyer](https://avatars.githubusercontent.com/u/221173?v=4)](https://github.com/dfeyer "dfeyer (4 commits)")[![hlubek](https://avatars.githubusercontent.com/u/33351?v=4)](https://github.com/hlubek "hlubek (4 commits)")[![foerthner](https://avatars.githubusercontent.com/u/564857?v=4)](https://github.com/foerthner "foerthner (3 commits)")[![aertmann](https://avatars.githubusercontent.com/u/903567?v=4)](https://github.com/aertmann "aertmann (2 commits)")[![cognifloyd](https://avatars.githubusercontent.com/u/1558590?v=4)](https://github.com/cognifloyd "cognifloyd (2 commits)")[![dlubitz](https://avatars.githubusercontent.com/u/13046100?v=4)](https://github.com/dlubitz "dlubitz (2 commits)")[![mficzel](https://avatars.githubusercontent.com/u/1309380?v=4)](https://github.com/mficzel "mficzel (1 commits)")[![kitsunet](https://avatars.githubusercontent.com/u/324408?v=4)](https://github.com/kitsunet "kitsunet (1 commits)")[![timdeluxe](https://avatars.githubusercontent.com/u/5765175?v=4)](https://github.com/timdeluxe "timdeluxe (1 commits)")

---

Tags

hacktoberfest

### Embed Badge

![Health badge](/badges/neos-doctools/health.svg)

```
[![Health](https://phpackages.com/badges/neos-doctools/health.svg)](https://phpackages.com/packages/neos-doctools)
```

###  Alternatives

[neos/eel

The Embedded Expression Language (Eel) is a building block for creating Domain Specific Languages

122.0M27](/packages/neos-eel)[neos/form

Extensible and flexible API for building web forms

18853.0k40](/packages/neos-form)[neos/fusion-form

Fusion Form

19724.3k31](/packages/neos-fusion-form)[ttree/scheduler

Simple task scheduler for Neos Flow Framework

21108.8k1](/packages/ttree-scheduler)[avency/neos-vardump

Neos VarDump Package

147.1k](/packages/avency-neos-vardump)[flowpack/task

A Task scheduler for Neos Flow

1136.3k1](/packages/flowpack-task)

PHPackages © 2026

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