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.
 
 
 
 
 
 
..
markdown
oldlogs
.gitignore
CHANGES
CMAKE
CUSTOMIZE
DEBUG
DOCGUIDE
FTL.TXT
GPLv2.TXT
INSTALL
INSTALL.ANY
INSTALL.CROSS
INSTALL.GNU
INSTALL.MAC
INSTALL.UNIX
INSTALL.VMS
MAKEPP
PROBLEMS
README
TODO
VERSIONS.TXT
formats.txt
freetype-config.1
freetype-web.txt
raster.txt
release

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.

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