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

CONTRIBUTING: remove -n from sphinx-build, add cmake target

Browse Source 
The -n flag adds warnings about preexisting problems because we don't
check it in CI, so let's not recommend that.

Not everyone uses cmake but it's still the source of truth for docs,
so mention the cmake incantation.  Though it seems like the direct
sphinx-build invocation works just fine, so keep it first.
This commit is contained in:
Johannes Altmanninger
2025-11-30 06:24:39 +01:00
parent 7c27c1e7d0
commit 198768a1c7
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.rst
View File

@@ -89,11 +89,18 @@ Contributing documentation
The documentation is stored in ``doc_src/``, and written in ReStructured Text and built with Sphinx.
To build it locally, run from the main fish-shell directory::
To build it locally, run either::
sphinx-build -j 8 -b html -n doc_src/ /tmp/fish-doc/
sphinx-build -j auto -b html doc_src/ /tmp/fish-doc/
which will build the docs as html in /tmp/fish-doc. You can open it in a browser and see that it looks okay.
which will output HTML docs to /tmp/fish-doc.
You can open it in a browser and see that it looks okay.
Alternatively, you can use::
cmake --build build -t sphinx-docs
which outputs to build/user_doc/html/.
The builtins and various functions shipped with fish are documented in doc_src/cmds/.