PHPackages                             gobst/buildadoc - 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. gobst/buildadoc

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

gobst/buildadoc
===============

BuildADoc is a PHP documentation generator designed specifically for DokuWiki.

v1.0.4(1y ago)21BSD-3-ClausePHPPHP ^8.3CI passing

Since Sep 25Pushed 1y ago1 watchersCompare

[ Source](https://github.com/gobst/buildadoc)[ Packagist](https://packagist.org/packages/gobst/buildadoc)[ RSS](/packages/gobst-buildadoc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (11)Versions (8)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/5ed4f9a6a1128b05d23fcd4425e0de8d23582f140f934a216090442efc665d00/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f676f6273742f6275696c6461646f633f6c6162656c3d6c6174657374253230737461626c6526636f6c6f723d6461726b677265656e)](https://camo.githubusercontent.com/5ed4f9a6a1128b05d23fcd4425e0de8d23582f140f934a216090442efc665d00/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f676f6273742f6275696c6461646f633f6c6162656c3d6c6174657374253230737461626c6526636f6c6f723d6461726b677265656e)[![License](https://camo.githubusercontent.com/1c79777893b63d85b3dcdb33dbf24474112d635af04b7b26d4ff61c682d81604/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f676f6273742f6275696c6461646f633f6c6162656c3d6c6963656e736526636f6c6f723d6461726b677265656e)](https://camo.githubusercontent.com/1c79777893b63d85b3dcdb33dbf24474112d635af04b7b26d4ff61c682d81604/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f676f6273742f6275696c6461646f633f6c6162656c3d6c6963656e736526636f6c6f723d6461726b677265656e)[![PHP Version Required](https://camo.githubusercontent.com/aadb0d1ba6940ba05540bf5b10a13f9f2559b41cef2e28b948dd3e87934a01d7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f676f6273742f6275696c6461646f633f6c6162656c3d504850253230726571756972656426636f6c6f723d6461726b677265656e)](https://camo.githubusercontent.com/aadb0d1ba6940ba05540bf5b10a13f9f2559b41cef2e28b948dd3e87934a01d7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f676f6273742f6275696c6461646f633f6c6162656c3d504850253230726571756972656426636f6c6f723d6461726b677265656e)[![Coverage Status](https://camo.githubusercontent.com/4bc5dccaac23e6a96c0bc86ec1d6260f76464faab8d68c7c470bddf104465e5a/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f676f6273742f6275696c6461646f632f62616467652e7376673f6272616e63683d6d61696e)](https://coveralls.io/github/gobst/buildadoc?branch=main)[![Mutation testing badge](https://camo.githubusercontent.com/47be1cebfdc613e74eceb1082e08aad7aab5c5956496088ffd72b88feb1e142c/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246676f6273742532466275696c6461646f632532466d61696e)](https://dashboard.stryker-mutator.io/api/reports/github.com/gobst/buildadoc/main)

BuildADoc
=========

[](#buildadoc)

About
-----

[](#about)

BuildADoc is a PHP documentation generator designed specifically for [DokuWiki](https://github.com/dokuwiki/dokuwiki). It parses your PHP classes and converts them into DokuWiki-compatible syntax for seamless integration with your documentation workflow.

### Key Features:

[](#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
------------

[](#requirements)

- PHP 8.3 or higher
- [Docker](https://www.docker.com/) (optional)

Installation
------------

[](#installation)

To install BuildADoc directly into your project you can use [Composer](https://getcomposer.org/) with the command:

```
composer require gobst/buildadoc
```

Usage
-----

[](#usage)

### 1. Within your project

[](#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

[](#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
-------

[](#support)

If you encounter any issues or have questions, feel free to open an issue in the [GitHub Issue Tracker](https://github.com/gobst/buildadoc/issues).

License
-------

[](#license)

Distributed under the BSD 3-Clause license. See [LICENSE](LICENSE) for more information.

Acknowledgments
---------------

[](#acknowledgments)

- [ApiGen](https://github.com/ApiGen/ApiGen) for inspiration.
- [DokuWiki](https://github.com/dokuwiki/dokuwiki) for providing an excellent documentation platform.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance41

Moderate activity, may be stable

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity59

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

Every ~11 days

Total

5

Last Release

554d ago

PHP version history (2 changes)v1.0.0-betaPHP >=8.3

v1.0.1PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/21982ae74790fb8de0473d11a3e6a437d9ed292697b9e0991ec82c5e9427a443?d=identicon)[gobst](/maintainers/gobst)

---

Top Contributors

[![gobst](https://avatars.githubusercontent.com/u/116959669?v=4)](https://github.com/gobst "gobst (787 commits)")

---

Tags

documentationdokuwikigeneratorphpphpdocumentationgeneratordokuwiki

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/gobst-buildadoc/health.svg)

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

###  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)[behat/behat

Scenario-oriented BDD framework for PHP

4.0k96.8M2.0k](/packages/behat-behat)[symplify/monorepo-builder

Not only Composer tools to build a Monorepo.

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

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[civicrm/civicrm-core

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

728272.9k20](/packages/civicrm-civicrm-core)

PHPackages © 2026

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