tests/test_functions/sphinx-shared.sh

#!/bin/sh

set -e

cleanup () {
    if [ -n "$tmp_dir" ] && [ -e "$tmp_dir" ]; then
        rm -r "$tmp_dir"
    fi
}

trap cleanup EXIT INT TERM HUP

workspace_root=$(dirname "$0")/../..
builder=$1
shift
docsrc=$workspace_root/doc_src
tmp_dir=$(mktemp -d)
doctree=$tmp_dir/doctree
output_dir=$tmp_dir/$builder
sphinx-build \
    -j auto \
    -q \
    -W \
    -E \
    -b "$builder" \
    -c "$docsrc" \
    -d "$doctree" \
    "$@" \
    "$docsrc" \
    "$output_dir"
Split up sphinx HTML and MAN file generation This test is the one with the longest runtime. Splitting the two targets into separate tests allows them to run in parallel, which can speed up the tests. 2025-06-11 19:00:32 +02:00			`#!/bin/sh`

			`set -e`

			`cleanup () {`
Standardize shell script indent level We have a mixture of 2 and 4 space indent. 4 benchmarks/driver.sh 2 build_tools/check.sh 4 build_tools/git_version_gen.sh 4 build_tools/mac_notarize.sh 2 build_tools/make_pkg.sh 2 build_tools/make_tarball.sh 2 build_tools/make_vendor_tarball.sh 4 docker/docker_run_tests.sh 4 osx/install.sh 2 tests/test_functions/sphinx-shared.sh Our editorconfig file specifies 2, with no explicit reason. Our fish and Python scripts use 4, so let's use that. 2025-06-19 12:00:43 +02:00			`if [ -n "$tmp_dir" ] && [ -e "$tmp_dir" ]; then`
			`rm -r "$tmp_dir"`
			`fi`
Split up sphinx HTML and MAN file generation This test is the one with the longest runtime. Splitting the two targets into separate tests allows them to run in parallel, which can speed up the tests. 2025-06-11 19:00:32 +02:00			`}`

			`trap cleanup EXIT INT TERM HUP`

Rename repo_root to workspace_root This seems like a slightly better term because I think it also applies to tarball. Ref: https://github.com/fish-shell/fish-shell/pull/11785#discussion_r2335280389 2025-09-13 10:18:32 +02:00			`workspace_root=$(dirname "$0")/../..`
Split up sphinx HTML and MAN file generation This test is the one with the longest runtime. Splitting the two targets into separate tests allows them to run in parallel, which can speed up the tests. 2025-06-11 19:00:32 +02:00			`builder=$1`
Commit help_sections data file The help_sections.rs file was added to the tarball only as a quick hack. There is a cyclic dependency between docs and fish: "fish_indent" via "crates/build-man-pages" depends on "doc_src/". So every "touch doc_src/foo.rst && ninja -Cbuild sphinx-docs" re-builds fish. In future "fish_indent" should not depend on "crates/build-man-pages". Until then, a following commit wants to break this cyclic dependency in a different way: we won't embed man pages (matching historical behavior), which means that CMake builds won't need to run sphinx-build. But sphinx-build is also used for extracting help sections. Also, the fix for #12082 will use help sections elsewhere in the code. Prepare to remove the dependency on doc_src by committing the help sections (we already do elsewhere). 2025-11-20 10:34:17 +01:00			`shift`
Rename repo_root to workspace_root This seems like a slightly better term because I think it also applies to tarball. Ref: https://github.com/fish-shell/fish-shell/pull/11785#discussion_r2335280389 2025-09-13 10:18:32 +02:00			`docsrc=$workspace_root/doc_src`
Split up sphinx HTML and MAN file generation This test is the one with the longest runtime. Splitting the two targets into separate tests allows them to run in parallel, which can speed up the tests. 2025-06-11 19:00:32 +02:00			`tmp_dir=$(mktemp -d)`
			`doctree=$tmp_dir/doctree`
			`output_dir=$tmp_dir/$builder`
			`sphinx-build \`
Standardize shell script indent level We have a mixture of 2 and 4 space indent. 4 benchmarks/driver.sh 2 build_tools/check.sh 4 build_tools/git_version_gen.sh 4 build_tools/mac_notarize.sh 2 build_tools/make_pkg.sh 2 build_tools/make_tarball.sh 2 build_tools/make_vendor_tarball.sh 4 docker/docker_run_tests.sh 4 osx/install.sh 2 tests/test_functions/sphinx-shared.sh Our editorconfig file specifies 2, with no explicit reason. Our fish and Python scripts use 4, so let's use that. 2025-06-19 12:00:43 +02:00			`-j auto \`
			`-q \`
			`-W \`
			`-E \`
			`-b "$builder" \`
			`-c "$docsrc" \`
			`-d "$doctree" \`
Commit help_sections data file The help_sections.rs file was added to the tarball only as a quick hack. There is a cyclic dependency between docs and fish: "fish_indent" via "crates/build-man-pages" depends on "doc_src/". So every "touch doc_src/foo.rst && ninja -Cbuild sphinx-docs" re-builds fish. In future "fish_indent" should not depend on "crates/build-man-pages". Until then, a following commit wants to break this cyclic dependency in a different way: we won't embed man pages (matching historical behavior), which means that CMake builds won't need to run sphinx-build. But sphinx-build is also used for extracting help sections. Also, the fix for #12082 will use help sections elsewhere in the code. Prepare to remove the dependency on doc_src by committing the help sections (we already do elsewhere). 2025-11-20 10:34:17 +01:00			`"$@" \`
Standardize shell script indent level We have a mixture of 2 and 4 space indent. 4 benchmarks/driver.sh 2 build_tools/check.sh 4 build_tools/git_version_gen.sh 4 build_tools/mac_notarize.sh 2 build_tools/make_pkg.sh 2 build_tools/make_tarball.sh 2 build_tools/make_vendor_tarball.sh 4 docker/docker_run_tests.sh 4 osx/install.sh 2 tests/test_functions/sphinx-shared.sh Our editorconfig file specifies 2, with no explicit reason. Our fish and Python scripts use 4, so let's use that. 2025-06-19 12:00:43 +02:00			`"$docsrc" \`
			`"$output_dir"`