janschoenherr / docs.puli.io

The Puli documentation.

Puli Documentation

This repository contains the documentation for the Puli project. The rendered documentation is hosted at Read the Docs.

Authors

• Bernhard Schussek a.k.a. @webmozart
• The Community Contributors

Contribute

Contributions to the documentation are always welcome!

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at Puli’s Git repository.

Compile the documentation

To compile the documentation and see your changes, you need the sphinx-php python package. Install it via pip:

$ pip install "git+https://github.com/fabpot/sphinx-php.git#egg=sphinx-php"

Then compile it to HTML:

$ make html

Support

If you are having problems, send a mail to [e-mail] or shout out to @PuliPHP on Twitter.

License

The documentation is licensed under the MIT license.