[docs] (2/2) Fix generation of API documentation (#56745).
Creating the API Reference in the (new) `reference' sub-directory is consistent with other documentation sub-topics, such as `design', `glyphs' and `tutorial'. This patch fixes broken hyperlinks in the documentation pointing to and from the API Reference. It also allows web assets to load from their relative paths. * builds/freetype.mk (DOC_DIR): Adjust. (refdoc, refdoc-venv): Add `--site' argument. * builds/toplevel.mk (do-dist): Updated.
This commit is contained in:
parent
237fed6d5a
commit
496601e504
19
ChangeLog
19
ChangeLog
|
@ -1,3 +1,20 @@
|
|||
2019-12-21 Hugh McMaster <hugh.mcmaster@outlook.com>
|
||||
|
||||
[docs] (2/2) Fix generation of API documentation (#56745).
|
||||
|
||||
Creating the API Reference in the (new) `reference' sub-directory is
|
||||
consistent with other documentation sub-topics, such as `design',
|
||||
`glyphs' and `tutorial'.
|
||||
|
||||
This patch fixes broken hyperlinks in the documentation pointing to
|
||||
and from the API Reference. It also allows web assets to load from
|
||||
their relative paths.
|
||||
|
||||
* builds/freetype.mk (DOC_DIR): Adjust.
|
||||
(refdoc, refdoc-venv): Add `--site' argument.
|
||||
|
||||
* builds/toplevel.mk (do-dist): Updated.
|
||||
|
||||
2019-12-21 Hugh McMaster <hugh.mcmaster@outlook.com>
|
||||
|
||||
[docs] (1/2) Move static web assets (#56745).
|
||||
|
@ -61,7 +78,7 @@
|
|||
2019-12-09 Dominik Röttsches <drott@chromium.org>
|
||||
|
||||
Fix more UBSan warnings on adding offset to nullptr (#57384).
|
||||
|
||||
|
||||
* src/smooth/ftsmooth.c (ft_smooth_render_generic),
|
||||
src/psaux/psobjs.c (ps_table_add): Use `FT_OFFSET'.
|
||||
|
||||
|
|
|
@ -104,7 +104,7 @@ CONFIG_DIR := $(PUBLIC_DIR)/config
|
|||
|
||||
# The documentation directory.
|
||||
#
|
||||
DOC_DIR ?= $(TOP_DIR)/docs/reference
|
||||
DOC_DIR ?= $(TOP_DIR)/docs
|
||||
|
||||
# The final name of the library file.
|
||||
#
|
||||
|
@ -301,6 +301,7 @@ refdoc:
|
|||
$(PYTHON) -m docwriter \
|
||||
--prefix=ft2 \
|
||||
--title=FreeType-$(version) \
|
||||
--site=reference \
|
||||
--output=$(DOC_DIR) \
|
||||
$(PUBLIC_DIR)/*.h \
|
||||
$(PUBLIC_DIR)/config/*.h \
|
||||
|
@ -329,6 +330,7 @@ refdoc-venv:
|
|||
$(ENV_PYTHON) -m docwriter \
|
||||
--prefix=ft2 \
|
||||
--title=FreeType-$(version) \
|
||||
--site=reference \
|
||||
--output=$(DOC_DIR) \
|
||||
$(PUBLIC_DIR)/*.h \
|
||||
$(PUBLIC_DIR)/config/*.h \
|
||||
|
|
|
@ -268,7 +268,7 @@ do-dist: distclean refdoc
|
|||
cp $(CONFIG_SUB) builds/unix
|
||||
|
||||
@# Remove intermediate files created by the `refdoc' target.
|
||||
rm -rf docs/reference/markdown
|
||||
rm -f docs/reference/mkdocs.yml
|
||||
rm -rf docs/markdown
|
||||
rm -f docs/mkdocs.yml
|
||||
|
||||
# EOF
|
||||
|
|
Loading…
Reference in New Issue