rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
freetype2/docs
History
Ben Wagner 4082b863c1 Document direct header inclusion valid since 2.6.1. 
Since commit e13391333 'Make macros for header file names optional.' the
header file layout has become public and using the macro expansions for
includes is no longer required.  While this happened in 2.10.3, the header
file layout had not changed since commit 392cf22f8a 'Another adjustment to
header locations.' in 2.6.1.  Retroactively make the header file layout
public back to 2.6.1 to speed adoption.
 		2021-07-17 08:51:32 +02:00
..
markdown [docs] Update docwriter stylesheet for 1.3.1. 2021-03-28 15:07:05 +05:30
oldlogs Move old ChangeLog files to new `docs/oldlogs` directory. 2021-01-22 09:08:03 +01:00
.gitignore [docs] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
CHANGES docs/CHANGES: Mention slight rendering changes. 2021-07-16 08:20:44 +02:00
CMAKE * docs/CMAKE: New dummy file. 2013-11-10 06:26:52 +01:00
CUSTOMIZE Update all copyright notices. 2021-01-17 07:18:48 +01:00
DEBUG [base] Add trace level to logging output. 2021-06-25 09:24:07 +02:00
DOCGUIDE Update all copyright notices. 2021-01-17 07:18:48 +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 A few words on prerequisites. 2021-04-10 23:32:20 -04:00
INSTALL.ANY Document direct header inclusion valid since 2.6.1. 2021-07-17 08:51:32 +02:00
INSTALL.CROSS Update all copyright notices. 2021-01-17 07:18:48 +01:00
INSTALL.GNU Various documentation improvements and fixes. 2021-06-08 17:44:53 +02:00
INSTALL.MAC Minor documentation updates. 2017-01-13 10:33:09 +01:00
INSTALL.UNIX A few words on prerequisites. 2021-04-10 23:32:20 -04:00
INSTALL.VMS Update all copyright notices. 2021-01-17 07:18:48 +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. 2021-01-17 07:18:48 +01:00
VERSIONS.TXT Update all copyright notices. 2021-01-17 07:18:48 +01:00
formats.txt Update all copyright notices. 2021-01-17 07:18:48 +01:00
freetype-config.1 * Version 2.10.4 released. 2020-10-20 07:13:33 +02:00
raster.txt Update all copyright notices. 2021-01-17 07:18:48 +01:00
release Update all copyright notices. 2021-01-17 07:18:48 +01: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'.