x11/wezterm: install documentation

Increases install size by ~70 MiB but there're no manpages.
This commit is contained in:
Jan Beich 2021-08-28 11:53:54 +00:00
parent 4dee6f6620
commit 0df0f539c2
2 changed files with 53 additions and 1 deletions

View file

@ -1,6 +1,6 @@
PORTNAME= wezterm
DISTVERSION= 20210814-124438-54e29167
PORTREVISION= 2
PORTREVISION= 3
CATEGORIES= x11
MAINTAINER= jbeich@FreeBSD.org
@ -546,6 +546,12 @@ CARGO_USE_GITHUB= yes
# XXX https://github.com/rust-lang/cargo/issues/4101
CARGO_INSTALL_PATH= ${PLIST_FILES:Mbin/*:T}
OPTIONS_DEFINE= DOCS
DOCS_BUILD_DEPENDS= mdbook:textproc/mdbook \
mdbook-linkcheck:textproc/mdbook-linkcheck
PORTDOCS= html
post-patch:
# Extract (snapshot) version from the port instead of .tag file
@${ECHO_CMD} '${DISTVERSIONFULL}' >${WRKSRC}/.tag
@ -553,6 +559,19 @@ post-patch:
@${REINPLACE_CMD} -e 's/"python3"/"${PYTHON_CMD:T}"/' \
${WRKSRC}/cargo-crates/xcb-*/build.rs
do-build-DOCS-on:
# Build HTML documentation similar to ci/build-docs.sh
(cd ${WRKSRC} && ${PYTHON_CMD} ci/generate-docs.py)
mdbook build ${WRKSRC}/docs
${CP} ${WRKSRC}/assets/icon/terminal.png \
${WRKSRC}/gh_pages/html/favicon.png
${CP} ${WRKSRC}/assets/icon/${PORTNAME}-icon.svg \
${WRKSRC}/gh_pages/html/favicon.svg
do-install-DOCS-on:
(cd ${WRKSRC}/gh_pages && ${COPYTREE_SHARE} \
"${PORTDOCS:Mhtml}" ${STAGEDIR}${DOCSDIR})
post-install:
# Install assets similar to ci/deploy.sh
.for f in ${PORTNAME}.desktop ${PORTNAME}.appdata.xml \

View file

@ -0,0 +1,33 @@
Drop installation chapter as it requires network during build
--- ci/generate-docs.py.orig 2021-08-14 19:44:38 UTC
+++ ci/generate-docs.py
@@ -114,17 +114,6 @@ TOC = [
"wezterm",
"index.md",
children=[
- Page(
- "Install",
- "installation.md",
- children=[
- Page("Windows", "install/windows.md"),
- Page("macOS", "install/macos.md"),
- Page("Linux", "install/linux.md"),
- Page("FreeBSD", "install/freebsd.md"),
- Page("Build from source", "install/source.md"),
- ],
- ),
Page("Features", "features.md"),
Page("Change Log", "changelog.md"),
Page(
--- docs/contributing.md.orig 2021-08-14 19:44:38 UTC
+++ docs/contributing.md
@@ -8,7 +8,7 @@ If you're thinking of helping out, then the following
* [WezTerm on GitHub](https://github.com/wez/wezterm)
* [GitHub Discussions](https://github.com/wez/wezterm/discussions)
* [Realtime conversation with wez on Element.io/Gitter](help.html)
-* [Building from Source](install/source.html)
+* [Building from Source](https://github.com/wez/wezterm/blob/main/docs/install/source.markdown)
* [Where to find things and hacking on wezterm](https://github.com/wez/wezterm/blob/master/CONTRIBUTING.md#contributing-to-wezterm)
I like to think that I have an open mind and I try to be open to ideas,