e4586d960f
========================== Tag sources with `VER-2-13-1'. * docs/VERSION.TXT: Add entry for version 2.13.1. * docs/CHANGES: Updated. * docs/release, docs/README, builds/macs/README: Updated. * README, src/base/ftver.rc, builds/windows/vc2010/index.html, builds/windows/visualc/index.html, builds/windows/visualce/index.html, builds/wince/vc2005-ce/index.html, builds/wince/vc2008-ce/index.html, docs/freetype-config.1: s/2.13.0/2.13/1/, s/2130/2131/. * include/freetype/freetype.h (FREETYPE_PATCH): Set to 1. * builds/unix/configure.raw (version_info): Set to 26:0:20. * CMakeLists.txt (VERSION_PATCH): Set to 1. * subprojects/libpng.wrap, subprojects/zlib.wrap, subprojects/dlg: Updated.
34 lines
1.2 KiB
Plaintext
34 lines
1.2 KiB
Plaintext
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'.
|