Download the PHP package jakota/documentation-builder without Composer

On this page you can find all versions of the php package jakota/documentation-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of jakota/documentation-builder

Informations about the package documentation-builder

Documentation Builder

Build documentation with Sphinx from inside your PHP code.

Prerequisites

Detailed Usage

Add as require-dev

Create documentation folder like Documentation in the project root

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.

You can edit the text to your liking but don't remove the TocTreeInsert placeholder.

Next you want to add more DocBlocks to your PHP code.

Every line between

and

will be coped without the leading * into the file Demo/Index.rst.
And if TocTree: is set, this file will also be added to the TocTree in the main Index.rst.

You can add multiple DocBlocks wherever you want to one file.
But it is important that the indent of every line stays the same per DocBlock.

Config JSON

Create a folder for the config json and static files in your project root and name them whatever you like.

A recommended folder structure looks like this:

The content of this documentation.json file looks like this:

StartFolder and DocumentationFolder are relative to the Project-Root.
StaticFolder and TemplatesFolder are relative to the folder for the config.

Again, you can edit the config to your liking.
But for now only html is supported as DocumentationType.
You will see an error message if the config is not as expected.

Run the build script from your project root

For example:

Happy documenting :)

All versions of documentation-builder with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jakota/documentation-builder contains the following files

Loading the files please wait ....