Installation

The simplest way to install FORD is using pip. This can be done with the command

sudo pip install ford

Pip will automatically handle all dependencies for you. If you do not have administrative rights on the computer where you want to produce documentation, you can install FORD and its dependencies in a virtualenv located somewhere in your home directory.

If you wish to generate call-graphs, dependency graphs, and inheritance graphs then you will need to install the Graphviz binary. On Ubuntu and Debian based systems, this can be done with

sudo apt-get install graphviz

In order to provide faster generation of the search database, LXML can be installed. This may be done via pip, but doing so may require the installation of a Python development package (python-dev on Ubuntu) through your Linux distribution's package manager.

If you prefer, you can install all of those dependencies manually and clone FORD from Github. Place FORD somewhere in your PYTHONPATH.

Alternatively, on Mac OS X, FORD can be installed with the Homebrew package manager. To install the latest release published via Homebrew, use the command:

brew install FORD

If you prefer to install the current development master branch directly from github use:

brew install --HEAD FORD

To install FORD from source, e.g., from the git repository if you want to test the latest master branch or a pull request, please checkout the branch/commit you want to install or download a source archive from https://github.com/cmacmackin/ford/releases and then run:

python2 ./setup.py install

from the projects root directory.