Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.28 KB

installation.rst

File metadata and controls

65 lines (48 loc) · 2.28 KB
Raw

Installation

phpDocumentor can easily be installed either via PEAR or manually from Github at http://github.com/phpdocumentor/phpdocumentor2.

Independent to the chosen installation type has phpDocumentor several dependencies on other software packages. Some of these dependencies are only necessary when generating specific parts of the documentation, such as PDFs or Graphs. If a dependency is only limited to a subset of features it is denoted with the dependency entry below.

  • PHP 5.3.2
  • XSL extension for PHP, only applicable when generating HTML via XSL (recommended)
  • Graphviz, only applicable when generating Graphs (recommended)
  • wkhtmltopdf, only applicable when generating PDFs (not enabled by default)

phpDocumentor does not install these dependencies and will generate errors if they are missing.

PEAR

PEAR provides the latest released version of phpDocumentor and is an easy way to set up your machine.

You can prepare your PEAR installation using the following commands:

$ pear channel-discover pear.phpdoc.org

And to install phpDocumentor you can use the following command:

$ pear install phpdoc/phpDocumentor

When the installation is finished you can invoke the phpdoc command from any path in your system. Recommended is to read the basic-usage chapter, which will explain how to start using phpDocumentor.

Manual Installation

At http://phpdoc.org you can find the latest available release as download. It is also possible to download the development version though this is not recommended for production environments.

The steps necessary for manual installation are:

  1. download your preferred installation archive from http://phpdoc.org.
  2. unzip in your favourite location
  3. Depending upon your OS:
    1. For Linux or Mac OSX: create a symlink from <PHPDOC_PATH>/bin/phpdoc.php to your bin folder (usually /usr/bin) named phpdoc.
    2. For Windows: Add <PHPDOC_PATH>/bin to your PATH so that you can invoke phpdoc.bat from any location.

When the installation is finished you can invoke the phpdoc command from any path in your system. Recommended is to read the basic-usage chapter, which will explain how to start using phpDocumentor.