rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
freetype2/docs
History
Nikhil Ramakrishnan 21c2311e63 Update docwriter stylesheet. 
This change is required to support docwriter 1.2.1.

See

  https://github.com/freetype/docwriter/issues/36

for more information.

* docs/markdown/stylesheets/extra.css:
(.md-typeset code) -> (.md-typeset pre>code)
(pre) -> (pre>code)
(p, .md-typeset p, h4): Remove commented styles.
(table.index): Remove unused styles.
 		2020-03-01 00:37:31 +05:30
..
markdown Update docwriter stylesheet. 2020-03-01 00:37:31 +05:30
.gitignore [docs] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
CHANGES Minor. 2020-02-16 15:24:27 +01:00
CMAKE * docs/CMAKE: New dummy file. 2013-11-10 06:26:52 +01:00
CUSTOMIZE Update all copyright notices. 2020-01-19 17:05:19 +01:00
DEBUG Update all copyright notices. 2020-01-19 17:05:19 +01:00
DOCGUIDE Update all copyright notices. 2020-01-19 17:05:19 +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 Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.ANY Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.CROSS Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.GNU Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.MAC Minor documentation updates. 2017-01-13 10:33:09 +01:00
INSTALL.UNIX Update all copyright notices. 2020-01-19 17:05:19 +01:00
INSTALL.VMS Update all copyright notices. 2020-01-19 17:05:19 +01:00
LICENSE.TXT [bdf, base] Lift hash functions from bdf driver to base module. 2015-12-19 16:59:40 +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] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
TODO Update all copyright notices. 2020-01-19 17:05:19 +01:00
VERSIONS.TXT Update all copyright notices. 2020-01-19 17:05:19 +01:00
formats.txt Update all copyright notices. 2020-01-19 17:05:19 +01:00
freetype-config.1 * Version 2.10.1 released. 2019-07-01 15:56:34 +02:00
raster.txt Update all copyright notices. 2020-01-19 17:05:19 +01:00
release Update all copyright notices. 2020-01-19 17:05:19 +01:00

README 

After saying `make refdoc' or `make refdoc-venv' the `site/' directory
contains the FreeType API reference.  You need python 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.

* Ensure that `docwriter' is installed in the same python target that
`make refdoc' uses (python3/python2/python).

* `pip' and `python' may point to different versions of Python.  Check using
`python --version' and `pip --version'.

* If none of this works, send a mail to `freetype-devel@nongnu.org' or file
an issue at `https://github.com/freetype/docwriter/issues'.