h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-03 23:11:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

xtask: add html-docs task

Browse Source 
This task is a bit annoying to implement because `sphinx-build` depends
on `fish_indent`, so that needs to be built, and the binary location
added to `PATH`.

Building `fish_indent` can be avoided by setting the `--fish-indent`
argument to the path to an existing `fish_indent` executable.

Use the new xtask in CMake builds. To do so without having to add
configuration options about where to put the docs, or having to copy
them from the default location to `build/user_doc`, we instead get rid of
the `user_doc` directory and change the code which accesses the docs to
read them from the non-configurable default output location in Cargo's
target directory.

Part of #12292
This commit is contained in:
Daniel Rainer
2025-08-22 17:24:42 +02:00
committed by Johannes Altmanninger
parent 2f74785620
commit 20cc07c5cd
12 changed files with 141 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tests/checks/config-paths.fish
View File

@@ -11,8 +11,8 @@
# NOTE: When our executable is located outside the build directory, these are different.
# CHECKERR: config: paths.data: {{.*}}/share
# CHECKERR: config: paths.man: {{.*/user_doc/man|\|not found\|}}
# CHECKERR: config: paths.doc: {{.*/user_doc/html|\|not found\|}}
# CHECKERR: config: paths.man: {{.*/cargo/fish-docs/man|\|not found\|}}
# CHECKERR: config: paths.doc: {{.*/cargo/fish-docs/html|\|not found\|}}
# CHECKERR: config: sourcing {{.+}}/etc/config.fish
# CHECKERR: config: not sourcing {{.*}}/xdg_config_home/fish/config.fish (not readable or does not exist)