freetype2/docs
Werner Lemberg 978fdb292a docs/CHANGES: Updated. 2022-11-08 08:27:52 +01:00
..
markdown [docs] Correct favicon. 2022-05-31 22:40:55 -04:00
oldlogs s/fixed point/fixed-point/ 2022-06-21 17:08:04 +02:00
.gitignore [docs] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
CHANGES docs/CHANGES: Updated. 2022-11-08 08:27:52 +01:00
CMAKE * docs/CMAKE: New dummy file. 2013-11-10 06:26:52 +01:00
CUSTOMIZE Update all copyright notices. 2022-01-11 10:54:10 +01:00
DEBUG Update all copyright notices. 2022-01-11 10:54:10 +01:00
DOCGUIDE Update all copyright notices. 2022-01-11 10:54:10 +01:00
FTL.TXT Update or fix links to use the https protocol instead of http. 2017-12-04 20:43:30 +01:00
GPLv2.TXT Update license documentation. 2011-06-18 08:06:57 +02:00
INSTALL Update all copyright notices. 2022-01-11 10:54:10 +01:00
INSTALL.ANY Update all copyright notices. 2022-01-11 10:54:10 +01:00
INSTALL.CROSS Update all copyright notices. 2022-01-11 10:54:10 +01:00
INSTALL.GNU Update all copyright notices. 2022-01-11 10:54:10 +01:00
INSTALL.MAC Minor documentation updates. 2017-01-13 10:33:09 +01:00
INSTALL.UNIX Update all copyright notices. 2022-01-11 10:54:10 +01:00
INSTALL.VMS Update all copyright notices. 2022-01-11 10:54:10 +01:00
MAKEPP Fix links (mostly http -> https). 2018-12-25 22:44:05 +01:00
PROBLEMS * docs/PROBLEMS: Mention rendering differences on different 2011-02-24 20:01:00 +01:00
README [docs] Fix building docs if `srcdir' != `builddir'. 2020-03-22 23:29:51 +05:30
TODO Update all copyright notices. 2022-01-11 10:54:10 +01:00
VERSIONS.TXT * Version 2.12.1 released. 2022-05-01 07:09:34 +02:00
formats.txt Update all copyright notices. 2022-01-11 10:54:10 +01:00
freetype-config.1 * Version 2.12.1 released. 2022-05-01 07:09:34 +02:00
raster.txt Replace '1/64th' (and similar entries) with '1/64' in docs and comments. 2022-10-24 07:01:21 +02:00
release * Version 2.12.0 released. 2022-03-31 13:55:50 +02: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'.