mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-17 22:14:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Allow building docs using the develop infrastructure

Browse Source
This commit is contained in:
Kovid Goyal
2023-07-29 15:57:40 +05:30
parent ecbec79cff
commit 5c0fe23aa5
3 changed files with 93 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Makefile
View File

@@ -8,6 +8,7 @@ endif
# You can set these variables from the command line.
SPHINXOPTS = -n -q -j auto -T $(FAIL_WARN) $(OPTS)
SPHINXBUILD = sphinx-build
SPHINXAUTOBUILD = sphinx-autobuild
SPHINXPROJ = kitty
SOURCEDIR = .
BUILDDIR = _build
@@ -25,4 +26,4 @@ help:
develop-docs:
sphinx-autobuild --ignore "$(abspath $(SOURCEDIR))/generated/*" --watch ../kitty --watch ../kittens -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
$(SPHINXAUTOBUILD) --ignore "$(abspath $(SOURCEDIR))/generated/*" --watch ../kitty --watch ../kittens -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

5
docs/build.rst
View File

@@ -65,14 +65,13 @@ For more help on the various options supported by the build script::
Building the documentation
-------------------------------------
This will require
To have the kitty documentation available locally, run::
python3 -m pip install -r docs/requirements.txt && make docs
./dev.sh deps -for-docs && ./dev.sh docs
To develop the docs, with live reloading, use::
python3 -m pip install -r docs/requirements.txt && make develop-docs
./dev.sh deps -for-docs && ./dev.sh docs -live-reload
Dependencies
----------------