You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Hugh McMaster 237fed6d5a [docs] (1/2) Move static web assets (#56745). 5 years ago
..
markdown [docs] (1/2) Move static web assets (#56745). 5 years ago
.gitignore [docs] (1/2) Move static web assets (#56745). 5 years ago
CHANGES CHANGES: Updated. 5 years ago
CMAKE * docs/CMAKE: New dummy file. 11 years ago
CUSTOMIZE Update all copyright notices. 6 years ago
DEBUG docs/DEBUG: Document environment variable `FT2_KEEP_ALIVE'. 5 years ago
DOCGUIDE Update all copyright notices. 6 years ago
FTL.TXT Update or fix links to use the https protocol instead of http. 7 years ago
GPLv2.TXT Update license documentation. 14 years ago
INSTALL Update all copyright notices. 6 years ago
INSTALL.ANY Update all copyright notices. 6 years ago
INSTALL.CROSS Update all copyright notices. 6 years ago
INSTALL.GNU Update all copyright notices. 6 years ago
INSTALL.MAC Minor documentation updates. 8 years ago
INSTALL.UNIX Update all copyright notices. 6 years ago
INSTALL.VMS Update all copyright notices. 6 years ago
LICENSE.TXT [bdf, base] Lift hash functions from bdf driver to base module. 9 years ago
MAKEPP Fix links (mostly http -> https). 6 years ago
PROBLEMS * docs/PROBLEMS: Mention rendering differences on different 14 years ago
README [docs] (1/2) Move static web assets (#56745). 5 years ago
TODO Update all copyright notices. 6 years ago
VERSIONS.TXT * Version 2.10.1 released. 6 years ago
formats.txt Update all copyright notices. 6 years ago
freetype-config.1 * Version 2.10.1 released. 6 years ago
raster.txt Update all copyright notices. 6 years ago
release For distribution, replace `.tar.bz2' with `.tar.xz' bundles. 6 years ago

README

After saying `make refdoc' or `make refdoc-venv' the `site/' directory
contains the FreeType API reference. You need python 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.

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

* `pip' and `python' may point to different versions of Python. Check using
`python --version' and `pip --version'.

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