README.md

Neos.DocTools Documentation

Requirements

We need Sphinx (https://www.sphinx-doc.org/) 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

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 <reference>]

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 <reference>]