Dactyloidae/modules/freetype2/docs
2023-04-05 07:35:36 +08:00
..
oldlogs Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
reference Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
CHANGES Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
CMAKE import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo 2018-01-19 03:59:58 +08:00
CUSTOMIZE Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
DEBUG Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
DOCGUIDE Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
formats.txt Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
freetype-config.1 Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
FTL.TXT Update in-tree freetype2 lib (unused) to 2.9.1 2019-02-15 23:57:40 +08:00
GPLv2.TXT import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo 2018-01-19 03:59:58 +08:00
INSTALL Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
INSTALL.ANY Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
INSTALL.CROSS Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
INSTALL.GNU Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
INSTALL.MAC Update in-tree freetype2 lib (unused) to 2.9.1 2019-02-15 23:57:40 +08:00
INSTALL.UNIX Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
INSTALL.VMS Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
MAKEPP Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
PROBLEMS import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo 2018-01-19 03:59:58 +08:00
raster.txt Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
README Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
release Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
TODO Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00
VERSIONS.TXT Issue #1863 - Update freetype2 to 2.13.0. 2023-04-05 07:35:36 +08:00

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'.