freetype-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[freetype2] master 496601e 2/2: [docs] (2/2) Fix generation of API docum


From: Werner LEMBERG
Subject: [freetype2] master 496601e 2/2: [docs] (2/2) Fix generation of API documentation (#56745).
Date: Sat, 21 Dec 2019 17:13:32 -0500 (EST)

branch: master
commit 496601e5045bb9af24be4819646700a503ce103a
Author: Hugh McMaster <address@hidden>
Commit: Werner Lemberg <address@hidden>

    [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.
---
 ChangeLog          | 19 ++++++++++++++++++-
 builds/freetype.mk |  4 +++-
 builds/toplevel.mk |  4 ++--
 3 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 439fe39..7629573 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,22 @@
 2019-12-21  Hugh McMaster  <address@hidden>
 
+       [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  <address@hidden>
+
        [docs] (1/2) Move static web assets (#56745).
 
        * docs/reference/*: Move ...
@@ -61,7 +78,7 @@
 2019-12-09  Dominik Röttsches  <address@hidden>
 
        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'.
 
diff --git a/builds/freetype.mk b/builds/freetype.mk
index 2b0ffae..4c36ed0 100644
--- a/builds/freetype.mk
+++ b/builds/freetype.mk
@@ -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 \
diff --git a/builds/toplevel.mk b/builds/toplevel.mk
index 333b775..6648dc3 100644
--- a/builds/toplevel.mk
+++ b/builds/toplevel.mk
@@ -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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]