freetype2/docs
Alexei Podtelezhnikov b9b74f9f78 A few words on prerequisites. 2021-04-10 23:32:20 -04:00
..
markdown [docs] Update docwriter stylesheet for 1.3.1. 2021-03-28 15:07:05 +05:30
oldlogs Move old ChangeLog files to new `docs/oldlogs` directory. 2021-01-22 09:08:03 +01:00
.gitignore
CHANGES Add new function `FT_Get_Transform`. 2021-02-13 08:52:58 +01:00
CMAKE
CUSTOMIZE Update all copyright notices. 2021-01-17 07:18:48 +01:00
DEBUG Always provide logging API. 2021-01-31 14:28:44 +01:00
DOCGUIDE Update all copyright notices. 2021-01-17 07:18:48 +01:00
FTL.TXT
GPLv2.TXT
INSTALL A few words on prerequisites. 2021-04-10 23:32:20 -04:00
INSTALL.ANY Update all copyright notices. 2021-01-17 07:18:48 +01:00
INSTALL.CROSS Update all copyright notices. 2021-01-17 07:18:48 +01:00
INSTALL.GNU Update all copyright notices. 2021-01-17 07:18:48 +01:00
INSTALL.MAC
INSTALL.UNIX A few words on prerequisites. 2021-04-10 23:32:20 -04:00
INSTALL.VMS Update all copyright notices. 2021-01-17 07:18:48 +01:00
MAKEPP
PROBLEMS
README
TODO Update all copyright notices. 2021-01-17 07:18:48 +01:00
VERSIONS.TXT Update all copyright notices. 2021-01-17 07:18:48 +01:00
formats.txt Update all copyright notices. 2021-01-17 07:18:48 +01:00
freetype-config.1
raster.txt Update all copyright notices. 2021-01-17 07:18:48 +01:00
release Update all copyright notices. 2021-01-17 07:18:48 +01:00

README

After saying `make refdoc' or `make refdoc-venv' the `reference/' directory
contains the FreeType API reference.  You need Python >= 3.5 and pip to make
this target.

There are two ways to generate the documentation:

1. Using `make refdoc':

    - Ensure `python' and `pip' are available.
    - Install pip package `docwriter' with `pip install --user docwriter'.
    - Make target with `make refdoc'.
    - This target can be run offline once required packages are installed.

2. Using `make refdoc-venv' (requires internet access):

    - Ensure `python', `pip' and Python package `virtualenv' are available.
    - Make target with `make refdoc-venv'.
    - This may or may not require internet access every time depending on
    pip and system caching.

This also works with Jam: Just type `jam refdoc' in the main directory.

Some troubleshooting tips:

* Regularly run `pip install --upgrade docwriter' to check for updates which
may include bug fixes.

* `Docwriter' does not support Python 2.  Ensure that Python >= 3.5 is
installed and available as `python3'/`python'.

* Ensure that `docwriter' is installed in the same Python target that
`make refdoc' uses (python3/python).

* If none of this works, send a mail to `freetype-devel@nongnu.org' or file
an issue at `https://github.com/freetype/docwriter/issues'.