kc3-lang/freetype/docs

Diff

  • Show log

    Commit

  • Hash : 562f3481
    Author : suzuki toshiya
    Date : 2023-05-20T12:52:25

    [doc] Type1 GX (sfnt-wrapped Type1) is not supported. * docs/formats.txt: Clarify the reference of Type1 GX, and state that this format is not supported. This is because the content `TYP1' table is not exactly same with the Type1 font format specification; no eexec encryption is used. For detail and concrete examples, see the analysis on: https://gitlab.freedesktop.org/freetype/freetype/-/issues/1231

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

kmx.io     mail     discord kmxgit v0.4.0