gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-22 03:02:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make release doc update also register docs

Browse Source
This commit is contained in:
ISSOtm
2021-03-09 19:59:28 +01:00
parent 611bd46e0b
commit e9d9a44687
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
.github/actions/get-pages.sh vendored
View File

@@ -5,20 +5,21 @@ usage() {
Usage: $0 [-h] [-r] <rgbds-www> <version> Usage: $0 [-h] [-r] <rgbds-www> <version>
Copy renders from RGBDS repository to rgbds-www documentation Copy renders from RGBDS repository to rgbds-www documentation
Execute from the root folder of the RGBDS repo, checked out at the desired tag Execute from the root folder of the RGBDS repo, checked out at the desired tag
<rgbds-www> : Path to the '_documentation' folder in the rgbds-www repository <rgbds-www> : Path to the rgbds-www repository
<version> : Version to be copied, such as 'v0.4.1' or 'master' <version> : Version to be copied, such as 'v0.4.1' or 'master'
-h Display this help message -h Display this help message
-r Update "latest stable" redirection pages (use for releases, not master) -r Update "latest stable" redirection pages and add a new entry to the index
(use for releases, not master)
EOF EOF
} }
update_redirects=0 is_release=0
bad_usage=0 bad_usage=0
while getopts ":hr" opt; do while getopts ":hr" opt; do
case $opt in case $opt in
r) r)
update_redirects=1 is_release=1
;; ;;
h) h)
usage usage
@@ -50,7 +51,7 @@ PAGES=(
[gbz80.7.html]=src/gbz80.7 [gbz80.7.html]=src/gbz80.7
) )
WWWPATH="/docs" WWWPATH="/docs"
mkdir -p "$1/$2" mkdir -p "$1/_documentation/$2"
# `mandoc` uses a different format for referring to man pages present in the **current** directory # `mandoc` uses a different format for referring to man pages present in the **current** directory
# We want that format for RGBDS man pages, and the other one for the t=rest; # We want that format for RGBDS man pages, and the other one for the t=rest;
@@ -64,7 +65,7 @@ stem="${page%.html}"
manpage="${stem%.?}(${stem#*.})" manpage="${stem%.?}(${stem#*.})"
descr="$(awk -v 'FS=.Nd ' '/.Nd/ { print $2; }' "${PAGES[$page]}")" descr="$(awk -v 'FS=.Nd ' '/.Nd/ { print $2; }' "${PAGES[$page]}")"
cat >"$1/$2/$page" <<EOF cat >"$1/_documentation/$2/$page" <<EOF
--- ---
layout: doc layout: doc
title: $manpage [$2] title: $manpage [$2]
@@ -75,9 +76,9 @@ EOF
if [ $stem = rgbasm.5 ]; then if [ $stem = rgbasm.5 ]; then
options+=,toc options+=,toc
fi fi
mandoc -Thtml -I os=Linux -O$options "${PAGES[$page]##*/}" | .github/actions/doc_postproc.awk >> "$1/$2/$page" mandoc -Thtml -I os=Linux -O$options "${PAGES[$page]##*/}" | .github/actions/doc_postproc.awk >> "$1/_documentation/$2/$page"
if [ $update_redirects -ne 0 ]; then if [ $is_release -ne 0 ]; then
cat - >"$1/$page" <<EOF cat - >"$1/_documentation/$page" <<EOF
--- ---
redirect_to: $WWWPATH/$2/${page%.html} redirect_to: $WWWPATH/$2/${page%.html}
permalink: $WWWPATH/${page%.html}/ permalink: $WWWPATH/${page%.html}/
@@ -87,7 +88,7 @@ description: RGBDS latest stable — $descr
EOF EOF
fi fi
done done
cat - >"$1/$2/index.html" <<EOF cat - >"$1/_documentation/$2/index.html" <<EOF
--- ---
layout: doc_index layout: doc_index
permalink: /docs/$2/ permalink: /docs/$2/
@@ -96,5 +97,13 @@ description: RGBDS $2 - Online manual
--- ---
EOF EOF
# If making a release, add a new entry right after `master`
if [ $is_release -ne 0 ]; then
awk '{ print }
/"name": "master"/ { print "\t\t{\"name\": \"'$2'\", \"text\": \"'$2'\" }," }
' "$1/_data/doc.json" >"$1/_data/doc.json.tmp"
mv "$1/_data/doc.json"{.tmp,}
fi
# Clean up # Clean up
rm "${PAGES[@]##*/}" rm "${PAGES[@]##*/}"