https://github.com/neos/doctools

Tools for generating and rendering Flow and Neos documentation
https://github.com/neos/doctools

hacktoberfest

Last synced: 7 months ago
JSON representation

Tools for generating and rendering Flow and Neos documentation

• Host: GitHub
• URL: https://github.com/neos/doctools
• Owner: neos
• License: mit
• Created: 2015-08-18T19:35:54.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2025-03-04T10:17:22.000Z (10 months ago)
• Last Synced: 2025-05-07T18:08:10.869Z (8 months ago)
• Topics: hacktoberfest
• Language: PHP
• Homepage:
• Size: 3.68 MB
• Stars: 1
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

```yaml

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

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

```yaml

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 ]