https://github.com/gobst/buildadoc

Generates a PHP class documentation for DokuWiki
https://github.com/gobst/buildadoc

documentation dokuwiki generator php

Last synced: 5 months ago
JSON representation

Generates a PHP class documentation for DokuWiki

• Host: GitHub
• URL: https://github.com/gobst/buildadoc
• Owner: gobst
• License: bsd-3-clause
• Created: 2024-02-11T15:28:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-05T21:31:16.000Z (over 1 year ago)
• Last Synced: 2025-03-05T21:53:11.146Z (over 1 year ago)
• Topics: documentation, dokuwiki, generator, php
• Language: PHP
• Homepage:
• Size: 684 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Latest Stable Version](https://img.shields.io/packagist/v/gobst/buildadoc?label=latest%20stable&color=darkgreen)

![License](https://img.shields.io/packagist/l/gobst/buildadoc?label=license&color=darkgreen)

![PHP Version Required](https://img.shields.io/packagist/php-v/gobst/buildadoc?label=PHP%20required&color=darkgreen)

[![Coverage Status](https://coveralls.io/repos/github/gobst/buildadoc/badge.svg?branch=main)](https://coveralls.io/github/gobst/buildadoc?branch=main)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fgobst%2Fbuildadoc%2Fmain)](https://dashboard.stryker-mutator.io/api/reports/github.com/gobst/buildadoc/main)

# BuildADoc

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

- 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](https://www.docker.com/) (optional)

## Installation

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

```bash

composer require gobst/buildadoc

```

## Usage

### 1. Within your project

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

```bash 

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:

```bash 

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:

```bash

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](https://github.com/gobst/buildadoc/issues).

## License

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

## Acknowledgments

- [ApiGen](https://github.com/ApiGen/ApiGen) for inspiration.

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