README

BuildADoc

About

BuildADoc is a PHP documentation generator designed specifically for DokuWiki. It parses your PHP classes and converts them into DokuWiki-compatible syntax for seamless integration with your documentation workflow.

Key Features:

• Automatic generation of class documentation.
• Easy integration with DokuWiki installations.
• Planned Features:
  • Markdown format support.
  • usedByClasses feature for enhanced class relationship tracking.
  • trait support.

Requirements

• PHP 8.3 or higher
• Docker (optional)

Installation

To install BuildADoc directly into your project you can use Composer with the command:

composer require gobst/buildadoc

Usage

1. Within your project

To generate class documentation for DokuWiki, use the following command:

php bin/console.php DokuWiki:create-doc path/to/src/ /path/to/destination/dir/ projectname

The generated directories and files must be placed under your DokuWiki installation at /data/pages. For more options and information run:

php bin/console.php DokuWiki:create-doc -help

2. With Docker

You can also use the gobst/buildadoc Docker image to avoid setting up PHP dependencies directly on your system:

docker run --rm --tty --volume "$PWD:$PWD" --workdir "$PWD" gobst/buildadoc php bin/console.php DokuWiki:create-doc src/ /path/to/destination/dir/ projectname

Support

If you encounter any issues or have questions, feel free to open an issue in the GitHub Issue Tracker.

License

Distributed under the BSD 3-Clause license. See LICENSE for more information.

Acknowledgments

• ApiGen for inspiration.
• DokuWiki for providing an excellent documentation platform.