docs/reference/README

   1 After saying `make refdoc' or `make refdoc-venv' the `site/' directory
   2 contains the FreeType API reference.  You need python and pip to make this
   3 target.
   4
   5 There are two ways to generate the documentation:
   6
   7 1. Using `make refdoc':
   8
   9     - Ensure `python' and `pip' are available.
  10     - Install pip package `docwriter' with `pip install --user docwriter'.
  11     - Make target with `make refdoc'.
  12     - This target can be run offline once required packages are installed.
  13
  14 2. Using `make refdoc-venv' (requires internet access):
  15
  16     - Ensure `python', `pip' and python package `virtualenv' are available.
  17     - Make target with `make refdoc-venv'.
  18     - This may or may not require internet access every time depending on
  19     pip and system caching.
  20
  21 This also works with Jam: Just type `jam refdoc' in the main directory.
  22
  23 Some troubleshooting tips:
  24
  25 * Regularly run `pip install --upgrade docwriter' to check for updates which
  26 may include bug fixes.
  27
  28 * Ensure that `docwriter' is installed in the same python target that
  29 `make refdoc' uses (python3/python2/python).
  30
  31 * `pip' and `python' may point to different versions of Python.  Check using
  32 `python --version' and `pip --version'.
  33
  34 * If none of this works, send a mail to `freetype-devel@nongnu.org' or file
  35 an issue at `https://github.com/freetype/docwriter/issues'.