docs

Diff

Show log
Commit
Hash : c1e1a07f
Author :
Date : 2021-03-28T15:07:05

[docs] Update docwriter stylesheet for 1.3.1. This change is required to support docwriter 1.3.1. See https://gitlab.freedesktop.org/freetype/docwriter/-/merge_requests/101 for more information. * docs/markdown/stylesheets/extra.css: (.wy-nav-content, .md-sidebar--secondary): Remove.

Properties

Git HTTP	https://git.kmx.io/kc3-lang/freetype.git
Git SSH	git@git.kmx.io:kc3-lang/freetype.git
Public access ?	public
Description	https://gitlab.freedesktop.org/freetype/freetype
Users
Tags

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

kc3-lang/freetype/docs

Commit

Files

Properties

README