axmol/thirdparty/freetype/docs
halx99 5bcc77f0ef Update thirdparty libs 2021-08-19 22:53:54 +08:00
..
oldlogs Update thirdparty libs 2021-08-19 22:53:54 +08:00
reference Update thirdparty libs 2021-08-19 22:53:54 +08:00
CHANGES Update thirdparty libs 2021-08-19 22:53:54 +08:00
CMAKE Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
CUSTOMIZE Update thirdparty libs 2021-08-19 22:53:54 +08:00
DEBUG Update thirdparty libs 2021-08-19 22:53:54 +08:00
DOCGUIDE Update thirdparty libs 2021-08-19 22:53:54 +08:00
FTL.TXT Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
GPLv2.TXT Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
INSTALL Update thirdparty libs 2021-08-19 22:53:54 +08:00
INSTALL.ANY Update thirdparty libs 2021-08-19 22:53:54 +08:00
INSTALL.CROSS Update thirdparty libs 2021-08-19 22:53:54 +08:00
INSTALL.GNU Update thirdparty libs 2021-08-19 22:53:54 +08:00
INSTALL.MAC Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
INSTALL.UNIX Update thirdparty libs 2021-08-19 22:53:54 +08:00
INSTALL.VMS Update thirdparty libs 2021-08-19 22:53:54 +08:00
MAKEPP Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
PROBLEMS Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
README Rename external to thirdparty [ci build] 2021-06-08 20:45:55 +08:00
TODO Update thirdparty libs 2021-08-19 22:53:54 +08:00
VERSIONS.TXT Update thirdparty libs 2021-08-19 22:53:54 +08:00
formats.txt Update thirdparty libs 2021-08-19 22:53:54 +08:00
freetype-config.1 Update thirdparty libs 2021-08-19 22:53:54 +08:00
raster.txt Update thirdparty libs 2021-08-19 22:53:54 +08:00
release Update thirdparty libs 2021-08-19 22:53:54 +08: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'.