git: 9b37de0e37df - main - x11/wezterm: follow upstream and switch from mdbook to mkdocs for documentation generation
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 10 Jun 2025 08:18:15 UTC
The branch main has been updated by tagattie:
URL: https://cgit.FreeBSD.org/ports/commit/?id=9b37de0e37df80b727fadde56fb44d1d0149fabe
commit 9b37de0e37df80b727fadde56fb44d1d0149fabe
Author: Vladyslav Movchan <vladislav.movchan@gmail.com>
AuthorDate: 2025-04-19 19:36:50 +0000
Commit: Hiroki Tagato <tagattie@FreeBSD.org>
CommitDate: 2025-06-10 08:17:57 +0000
x11/wezterm: follow upstream and switch from mdbook to mkdocs for documentation generation
Also drop mdbook-related patch which is no longer necessary.
PR: 286227
Reported by: Vladyslav Movchan <vladislav.movchan@gmail.com> (maintainer)
---
x11/wezterm/Makefile | 37 ++++++++++++++++++++--------------
x11/wezterm/distinfo | 4 +++-
x11/wezterm/files/patch-fix-mdbook0448 | 24 ----------------------
3 files changed, 25 insertions(+), 40 deletions(-)
diff --git a/x11/wezterm/Makefile b/x11/wezterm/Makefile
index 8b775ac4cbee..2ceef3eacbbb 100644
--- a/x11/wezterm/Makefile
+++ b/x11/wezterm/Makefile
@@ -1,7 +1,7 @@
PORTNAME= wezterm
DISTVERSION= 20250213-133349
DISTVERSIONSUFFIX= -ee0c04e7
-PORTREVISION= 2
+PORTREVISION= 3
CATEGORIES= x11 wayland
MAINTAINER= vladislav.movchan@gmail.com
@@ -23,8 +23,9 @@ USES= cargo ssl xorg
USE_GITHUB= yes
USE_GITLAB= nodefault
USE_XORG= x11 xcb
-GH_ACCOUNT= wez
-GH_TAGNAME= ee0c04e735fb94cb5119681f704fb7fa6731e713
+GH_ACCOUNT= wez vladmovchan:build_docs_offline
+GH_PROJECT= wezterm freebsd-wezterm-port-extra-files:build_docs_offline
+GH_TAGNAME= ee0c04e735fb94cb5119681f704fb7fa6731e713 253f1e8:build_docs_offline
GH_TUPLE= freetype:freetype:42608f77f:freetype2/deps/freetype/freetype2 \
nyorain:dlg:72dfcc858:dlg/deps/freetype/freetype2/subprojects/dlg \
@@ -60,9 +61,10 @@ PLIST_FILES+= share/site-terminfo/w/wezterm
OPTIONS_DEFINE= DOCS
DOCS_USES= python:build
-DOCS_BUILD_DEPENDS= mdbook:textproc/mdbook \
- mdbook-linkcheck:textproc/mdbook-linkcheck \
- mdbook-mermaid:textproc/mdbook-mermaid
+DOCS_BUILD_DEPENDS= ${PYTHON_PKGNAMEPREFIX}mkdocs-material>0:textproc/py-mkdocs-material@${PY_FLAVOR} \
+ ${PYTHON_PKGNAMEPREFIX}mkdocs-macros-plugin>0:textproc/py-mkdocs-macros-plugin@${PY_FLAVOR} \
+ ${PYTHON_PKGNAMEPREFIX}mkdocs-include-markdown-plugin>0:textproc/py-mkdocs-include-markdown-plugin@${PY_FLAVOR} \
+ ${PYTHON_PKGNAMEPREFIX}mkdocs-exclude>0:textproc/py-mkdocs-exclude@${PY_FLAVOR}
PORTDOCS= html
.include <bsd.port.pre.mk>
@@ -82,17 +84,22 @@ post-patch:
do-build-DOCS-on:
# Build HTML documentation similar to ci/build-docs.sh
(cd ${WRKSRC} && ${PYTHON_CMD} ci/generate-docs.py)
- mdbook-mermaid install ${WRKSRC}/docs
- mdbook build ${WRKSRC}/docs
- ${CP} ${WRKSRC}/assets/icon/terminal.png \
- ${WRKSRC}/gh_pages/html/favicon.png
- ${CP} ${WRKSRC}/assets/icon/wezterm-icon.svg \
- ${WRKSRC}/gh_pages/html/favicon.svg
- ${RMDIR} ${WRKSRC}/gh_pages/html/install
+ ${REINPLACE_CMD} \
+ -e 's,/tmp/wezterm.releases.json,${WRKSRC_build_docs_offline}/wezterm.releases.json,' \
+ -e 's,/tmp/wezterm.nightly.json,${WRKSRC_build_docs_offline}/wezterm.nightly.json,' \
+ ${WRKSRC}/ci/subst-release-info.py
+ (cd ${WRKSRC} && ${PYTHON_CMD} ci/subst-release-info.py)
+ ${CP} ${WRKSRC}/assets/icon/terminal.png ${WRKSRC}/docs/favicon.png
+ ${CP} ${WRKSRC}/assets/icon/wezterm-icon.svg ${WRKSRC}/docs/favicon.svg
+ ${MKDIR} ${WRKSRC}/docs/fonts
+ ${CP} ${WRKSRC}/assets/fonts/SymbolsNerdFontMono-Regular.ttf \
+ ${WRKSRC}/docs/fonts/
+ (cd ${WRKSRC} && mkdocs build)
do-install-DOCS-on:
- (cd ${WRKSRC}/gh_pages && ${COPYTREE_SHARE} \
- "${PORTDOCS}" ${STAGEDIR}${DOCSDIR})
+ (cd ${WRKSRC}/gh_pages && \
+ ${COPYTREE_SHARE} . ${STAGEDIR}${DOCSDIR}/${PORTDOCS} \
+ "! -name *\.orig ! -name sitemap\.xml*")
post-install:
# Install assets similar to ci/deploy.sh
diff --git a/x11/wezterm/distinfo b/x11/wezterm/distinfo
index 4d117324b12d..5c9786114c17 100644
--- a/x11/wezterm/distinfo
+++ b/x11/wezterm/distinfo
@@ -1,4 +1,4 @@
-TIMESTAMP = 1740169598
+TIMESTAMP = 1745088121
SHA256 (rust/crates/addr2line-0.24.2.crate) = dfbe277e56a376000877090da837660b4427aad530e3028d44e0bffe4f89a1c1
SIZE (rust/crates/addr2line-0.24.2.crate) = 39015
SHA256 (rust/crates/adler-1.0.2.crate) = f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe
@@ -1377,6 +1377,8 @@ SHA256 (wez-xcb-imdkit-rs-358e226573461fe540efb920e2aad740e3c6fab1_GH0.tar.gz) =
SIZE (wez-xcb-imdkit-rs-358e226573461fe540efb920e2aad740e3c6fab1_GH0.tar.gz) = 28457
SHA256 (wez-wezterm-20250213-133349-ee0c04e7-ee0c04e735fb94cb5119681f704fb7fa6731e713_GH0.tar.gz) = 77ca469fc19d9e32faffd37083bd6683067b2eef284d53b1cd572e1fe39a7103
SIZE (wez-wezterm-20250213-133349-ee0c04e7-ee0c04e735fb94cb5119681f704fb7fa6731e713_GH0.tar.gz) = 82433452
+SHA256 (vladmovchan-freebsd-wezterm-port-extra-files-253f1e8_GH0.tar.gz) = 697287f3ebe961507b55bade74dd0bd602af8c8d74d4613a85fdf7a82739a1fa
+SIZE (vladmovchan-freebsd-wezterm-port-extra-files-253f1e8_GH0.tar.gz) = 94164
SHA256 (freetype-freetype-42608f77f_GH0.tar.gz) = 17d9fc59bdb6b3b091cba86a37e2cf0653c3d773929e0e852d2f3d2191b2cf02
SIZE (freetype-freetype-42608f77f_GH0.tar.gz) = 2482500
SHA256 (nyorain-dlg-72dfcc858_GH0.tar.gz) = 0597ba012ce49578f9ac6beab423c84fe5d8946984c577d4117a1d1f643ecb18
diff --git a/x11/wezterm/files/patch-fix-mdbook0448 b/x11/wezterm/files/patch-fix-mdbook0448
deleted file mode 100644
index b30986893412..000000000000
--- a/x11/wezterm/files/patch-fix-mdbook0448
+++ /dev/null
@@ -1,24 +0,0 @@
-From 5164e735c32d227050f753e197c5adcf54ba4dfe Mon Sep 17 00:00:00 2001
-From: Vladyslav Movchan <vladislav.movchan@gmail.com>
-Date: Tue, 8 Apr 2025 11:39:19 +0300
-Subject: [PATCH] Avoid duplication of `index.md` in `SUMMARY.md`
-
-This fixes the following `mdbook build` error when using mdbook 0.4.48:
-Error: Summary parsing failed for file="/tmp/wezterm/docs/./SUMMARY.md"
-Caused By: Duplicate file in SUMMARY.md: "index.md"
----
- ci/generate-docs.py | 2 +-
- 1 file changed, 1 insertion(+), 1 deletion(-)
-
-diff --git ci/generate-docs.py ci/generate-docs.py
-index f32b87d2ed7..6e73d8fbc23 100644
---- ci/generate-docs.py
-+++ ci/generate-docs.py
-@@ -508,6 +508,6 @@ def render(self, output, depth=0, mode="mdbook"):
-
-
- with open("SUMMARY.md", "w") as f:
-- f.write("[root](index.md)\n")
-+ f.write("[root]\n")
- for page in TOC:
- page.render(f, depth=1, mode="mdbook")