set shell := ["bash", "-uc"]

http_port := "8031"

builddir := "_build"

sphinxopts := ""

sphinxbuild := "uv run sphinx-build"

sourcedir := "."

export PYTHON_COLORS := "0"

export NO_COLOR := "1"

watch_files := "find .. -type f -not -path '*/\\.*' | grep -i '.*[.]\\(rst\\|md\\)$\\|.*[.]py$\\|CHANGES\\|TODO\\|.*conf\\.py' 2> /dev/null"

allsphinxopts := "-d " + builddir + "/doctrees " + sphinxopts + " ."

@just --list

[group: 'build']

{{ sphinxbuild }} -b dirhtml {{ allsphinxopts }} {{ builddir }}/html

@echo ""

@echo "Build finished. The HTML pages are in {{ builddir }}/html."

[group: 'build']

{{ sphinxbuild }} -b dirhtml {{ allsphinxopts }} {{ builddir }}/dirhtml

@echo ""

@echo "Build finished. The HTML pages are in {{ builddir }}/dirhtml."

[group: 'build']

{{ sphinxbuild }} -b singlehtml {{ allsphinxopts }} {{ builddir }}/singlehtml

@echo ""

@echo "Build finished. The HTML page is in {{ builddir }}/singlehtml."

[group: 'build']

{{ sphinxbuild }} -b epub {{ allsphinxopts }} {{ builddir }}/epub

@echo ""

@echo "Build finished. The epub file is in {{ builddir }}/epub."

[group: 'build']

{{ sphinxbuild }} -b latex {{ allsphinxopts }} {{ builddir }}/latex

@echo ""

@echo "Build finished; the LaTeX files are in {{ builddir }}/latex."

[group: 'build']

{{ sphinxbuild }} -b latex {{ allsphinxopts }} {{ builddir }}/latex

@echo "Running LaTeX files through pdflatex..."

make -C {{ builddir }}/latex all-pdf

@echo "pdflatex finished; the PDF files are in {{ builddir }}/latex."

[group: 'build']

{{ sphinxbuild }} -b text {{ allsphinxopts }} {{ builddir }}/text

@echo ""

@echo "Build finished. The text files are in {{ builddir }}/text."

[group: 'build']

{{ sphinxbuild }} -b man {{ allsphinxopts }} {{ builddir }}/man

@echo ""

@echo "Build finished. The manual pages are in {{ builddir }}/man."

[group: 'build']

{{ sphinxbuild }} -b json {{ allsphinxopts }} {{ builddir }}/json

@echo ""

@echo "Build finished; now you can process the JSON files."

[group: 'misc']

[confirm]

clean:

rm -rf {{ builddir }}/*

[group: 'misc']

{{ sphinxbuild }} -b htmlhelp {{ allsphinxopts }} {{ builddir }}/htmlhelp

@echo ""

@echo "Build finished; now you can run HTML Help Workshop with the .hhp project file in {{ builddir }}/htmlhelp."

[group: 'misc']

{{ sphinxbuild }} -b qthelp {{ allsphinxopts }} {{ builddir }}/qthelp

@echo ""

@echo "Build finished; now you can run 'qcollectiongenerator' with the .qhcp project file in {{ builddir }}/qthelp."

[group: 'misc']

{{ sphinxbuild }} -b devhelp {{ allsphinxopts }} {{ builddir }}/devhelp

@echo ""

@echo "Build finished."

[group: 'misc']

{{ sphinxbuild }} -b texinfo {{ allsphinxopts }} {{ builddir }}/texinfo

@echo ""

@echo "Build finished. The Texinfo files are in {{ builddir }}/texinfo."

[group: 'misc']

{{ sphinxbuild }} -b texinfo {{ allsphinxopts }} {{ builddir }}/texinfo

@echo "Running Texinfo files through makeinfo..."

make -C {{ builddir }}/texinfo info

@echo "makeinfo finished; the Info files are in {{ builddir }}/texinfo."

[group: 'misc']

{{ sphinxbuild }} -b gettext {{ sphinxopts }} . {{ builddir }}/locale

@echo ""

@echo "Build finished. The message catalogs are in {{ builddir }}/locale."

[group: 'validate']

{{ sphinxbuild }} -b linkcheck {{ allsphinxopts }} {{ builddir }}/linkcheck

@echo ""

@echo "Link check complete; look for any errors in the above output or in {{ builddir }}/linkcheck/output.txt."

[group: 'validate']

{{ sphinxbuild }} -b doctest {{ allsphinxopts }} {{ builddir }}/doctest

@echo "Testing of doctests in the sources finished, look at the results in {{ builddir }}/doctest/output.txt."

[group: 'validate']

rm -rf {{ builddir }}

{{ sphinxbuild }} -n -q ./ {{ builddir }}

[group: 'misc']

{{ sphinxbuild }} -b rediraffewritediff {{ allsphinxopts }} {{ builddir }}/redirects

@echo ""

@echo "Build finished. The redirects are in rediraffe_redirects."

[group: 'misc']

{{ sphinxbuild }} -b changes {{ allsphinxopts }} {{ builddir }}/changes

@echo ""

@echo "The overview file is in {{ builddir }}/changes."

[group: 'dev']

#!/usr/bin/env bash

[group: 'dev']

@echo '=============================================================='

@echo ''

@echo 'docs server running at http://localhost:{{ http_port }}/'

@echo ''

@echo '=============================================================='

python -m http.server {{ http_port }} --directory {{ builddir }}/html

[group: 'dev']

#!/usr/bin/env bash

[group: 'dev']

uv run sphinx-autobuild -b dirhtml "{{ sourcedir }}" "{{ builddir }}" {{ sphinxopts }} --port {{ http_port }}

[group: 'dev']

uv run sphinx-autobuild -b dirhtml "{{ sourcedir }}" "{{ builddir }}" {{ sphinxopts }} --port {{ http_port }} --watch "." -a