Getting Started

Please report any problems you have installing or using Doxhooks.

1. Install Python

Doxhooks requires Python 3.3 (or a newer version).

Note

It is unnecessary and probably a bad idea to uninstall Python 2.

Mac and Windows users can download Python and install it. *nix users can use their package manager.

2. Install pip

Doxhooks can be installed by pip.

pip is bundled with Python 3.4 (and newer versions). Install pip with the command:

Mac and *nix:python3 -m ensurepip
Windows:py -3 -m ensurepip

Some *nix distributions remove the bundled pip to a separate package.

pip is not bundled with Python 3.3. Download the get-pip script get-pip.py then install pip with the command:

Mac and *nix:python3 get-pip.py
Windows:py -3 get-pip.py

3. Install Doxhooks

Install Doxhooks with the command:

Mac, *nix and Windows:
 pip3 install doxhooks

4. Use Doxhooks

Copy and paste the files from one of the Doxhooks examples. Run the example script example.py with the command:

Mac and *nix:./example.py (or python3 example.py)
Windows:example.py (or py example.py)

Then edit and expand upon example.py to fit your project.