freetype/docs
Priyesh Kumar ab0ea068ee Update logging related documentation.
* docs/DEBUG: Updates related to `FT_LOGGING`.

* README.git: Updates related to logging.
2020-12-04 16:19:42 +01:00
..
markdown Update docwriter stylesheet. 2020-03-01 00:37:31 +05:30
.gitignore [docs] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
CHANGES [cff,cid,type1] Demote old engine for lack of CFF2. 2020-11-20 15:24:42 -05:00
CMAKE * docs/CMAKE: New dummy file. 2013-11-10 06:26:52 +01:00
CUSTOMIZE Update all copyright notices. 2020-01-19 17:05:19 +01:00
DEBUG Update logging related documentation. 2020-12-04 16:19:42 +01:00
DOCGUIDE Update all copyright notices. 2020-01-19 17:05:19 +01:00
formats.txt Update all copyright notices. 2020-01-19 17:05:19 +01:00
freetype-config.1 * Version 2.10.4 released. 2020-10-20 07:13:33 +02: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. 2020-01-19 17:05:19 +01:00
INSTALL.ANY Document changes to last release. 2020-10-10 12:48:18 +02:00
INSTALL.CROSS Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.GNU [docwriter] Drop support for Python < 3.5. 2020-03-21 20:17:17 +05:30
INSTALL.MAC Minor documentation updates. 2017-01-13 10:33:09 +01:00
INSTALL.UNIX Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.VMS Update all copyright notices. 2020-01-19 17:05:19 +01:00
LICENSE.TXT [bdf, base] Lift hash functions from bdf driver to base module. 2015-12-19 16:59:40 +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
raster.txt Update all copyright notices. 2020-01-19 17:05:19 +01:00
README [docs] Fix building docs if srcdir' != builddir'. 2020-03-22 23:29:51 +05:30
release Update all copyright notices. 2020-01-19 17:05:19 +01:00
TODO Update all copyright notices. 2020-01-19 17:05:19 +01:00
VERSIONS.TXT * Version 2.10.4 released. 2020-10-20 07:13:33 +02: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'.