PHPackages                             jakota/documentation-builder - 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. jakota/documentation-builder

ActiveSphinx-builder[Utility & Helpers](/categories/utility)

jakota/documentation-builder
============================

Build documentation with Sphinx from inside your PHP code.

1.1.0(2y ago)0118[2 issues](https://github.com/JAK0TA/DocumentationBuilder/issues)GPL-2.0-or-laterShell

Since Jul 2Pushed 2y ago2 watchersCompare

[ Source](https://github.com/JAK0TA/DocumentationBuilder)[ Packagist](https://packagist.org/packages/jakota/documentation-builder)[ RSS](/packages/jakota-documentation-builder/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)DependenciesVersions (3)Used By (0)

Documentation Builder
=====================

[](#documentation-builder)

Build documentation with Sphinx from inside your PHP code.

Prerequisites
-------------

[](#prerequisites)

- [Composer v2](https://getcomposer.org/download/)
- [Docker](https://www.docker.com/products/container-runtime)

Detailed Usage
--------------

[](#detailed-usage)

### Add as require-dev

[](#add-as-require-dev)

```
composer require --dev jakota/documentation-builder
```

### Create documentation folder like Documentation in the project root

[](#create-documentation-folder-like-documentation-in-the-project-root)

```
mkdir ./Documentation
```

### Add documentation blocks aka DocBlocks to your php files

[](#add-documentation-blocks-aka-docblocks-to-your-php-files)

The project needs a Index.rst to start from.

Add the following comment to a file.
Usually the main class or a file in the start folder.
It doesn't matter where this comment is located but it must not be found more than once.

```