wehub-resource-sync
302 lines
13 KiB
Makefile
302 lines
13 KiB
Makefile
# Makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
# Allow linkcheck to run without treating warnings as errors; -W will
|
|
# fast-fail if enabled; it's better to gather the whole list of bad links at once.
|
|
SPHINXOPTS = -a -E -W -j auto
|
|
LOCALSPHINXOPTS = -W -j auto
|
|
LINKCHECKOPTS = -a -E -j auto
|
|
# RtD-faithful build: our full-build options plus the two flags Read the Docs
|
|
# adds to its synthesized html command (-T full tracebacks, -D language=en).
|
|
RTDSPHINXOPTS = $(SPHINXOPTS) -T -D language=en
|
|
# Extra args forwarded to the preflight doctor (e.g. RTD_DOCTOR_ARGS=--warn-only
|
|
# to build despite environment drift).
|
|
RTD_DOCTOR_ARGS =
|
|
SPHINXBUILD = sphinx-build
|
|
SPHINXAUTOBUILD = sphinx-autobuild --port 0 --open-browser --ignore "*.log" --ignore "*data/examples*" --ignore "*train/examples*" --ignore "*serve/examples*"
|
|
PAPER =
|
|
BUILDDIR = _build
|
|
# Output directory for the html builder. Overridable so Read the Docs can point
|
|
# it at $READTHEDOCS_OUTPUT/html; defaults to the local _build/html.
|
|
HTMLDIR ?= $(BUILDDIR)/html
|
|
|
|
# User-friendly check for sphinx-build
|
|
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
|
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
|
endif
|
|
|
|
# Internal variables.
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
|
ALLLOCALSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(LOCALSPHINXOPTS) source
|
|
ALLRTDSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(RTDSPHINXOPTS) source
|
|
ALLLINKCHECKOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(LINKCHECKOPTS) source
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
|
|
|
.PHONY: help clean html rtd rtd-fallback rtd-build rtd-doctor dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext show
|
|
|
|
help:
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@echo " html to make standalone HTML files"
|
|
@echo " rtd-build to run a Read-the-Docs-faithful full build (preflight doctor + html)"
|
|
@echo " rtd-doctor to check this environment matches the Read the Docs build"
|
|
@echo " dirhtml to make HTML files named index.html in directories"
|
|
@echo " singlehtml to make a single large HTML file"
|
|
@echo " pickle to make pickle files"
|
|
@echo " json to make JSON files"
|
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
@echo " qthelp to make HTML files and a qthelp project"
|
|
@echo " applehelp to make an Apple Help Book"
|
|
@echo " devhelp to make HTML files and a Devhelp project"
|
|
@echo " epub to make an epub"
|
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
@echo " text to make text files"
|
|
@echo " man to make manual pages"
|
|
@echo " texinfo to make Texinfo files"
|
|
@echo " info to make Texinfo files and run them through makeinfo"
|
|
@echo " gettext to make PO message catalogs"
|
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
@echo " xml to make Docutils-native XML files"
|
|
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
@echo " linkcheck to check all external links for integrity"
|
|
@echo " linkcheck_all to check all external links for integrity"
|
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
@echo " coverage to run coverage check of the documentation (if enabled)"
|
|
|
|
clean:
|
|
rm -rf $(BUILDDIR)/*
|
|
rm -rf ./source/__pycache__/
|
|
rm -rf ./source/_ext/__pycache__/
|
|
rm -rf ./source/*/api/doc/*
|
|
rm -rf ./source/ray-core/compiled-graph/doc/*
|
|
rm -rf ./source/ray-references/api/*/doc/*
|
|
rm -rf ./source/cluster/running-applications/doc/*
|
|
rm -rf ./source/cluster/running-applications/job-submission/doc/*
|
|
rm -rf ./source/ray-observability/api/state/doc*
|
|
rm -rf ./source/rllib/package_ref/doc*
|
|
rm -rf ./source/ray-more-libs/doc/*
|
|
rm -rf ./source/ray-observability/reference/doc/*
|
|
rm -f ./source/data/examples.rst
|
|
rm -f ./source/serve/examples.rst
|
|
rm -f ./source/train/examples.rst
|
|
|
|
html:
|
|
@# Remove cached serve API stubs so autosummary regenerates them with correct templates
|
|
find source/serve/api/doc/ -name "ray.serve.*.rst" -delete 2>/dev/null || true
|
|
$(SPHINXBUILD) -W --keep-going -b html $(ALLSPHINXOPTS) $(HTMLDIR)
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(HTMLDIR)."
|
|
@echo "View the documentation by opening a browser and going to $(HTMLDIR)/index.html."
|
|
|
|
develop: html
|
|
|
|
RAY_DIR := $(shell pwd | rev | cut -d'/' -f2- | rev)
|
|
|
|
local:
|
|
python load_doc_cache.py --ray-dir=$(RAY_DIR)
|
|
@# Remove cached serve API stubs so autosummary regenerates them with correct templates
|
|
@# (pydantic v2 migration changed templates; cached stubs use old template with nested
|
|
@# autosummary :toctree: that generates unwanted per-member stub files)
|
|
find source/serve/api/doc/ -name "ray.serve.*.rst" -delete 2>/dev/null || true
|
|
python update_cache_env.py --ray-dir=$(RAY_DIR)
|
|
$(SPHINXAUTOBUILD) -W --keep-going -b html $(ALLLOCALSPHINXOPTS) $(BUILDDIR)/html
|
|
|
|
rtd-doctor:
|
|
python rtd_doctor.py $(RTD_DOCTOR_ARGS)
|
|
|
|
# RtD-faithful full build for local verification: reproduces the clean full
|
|
# build Read the Docs runs from a fresh checkout, so a clean build here means a
|
|
# clean build on RtD. Distinct from the `rtd` target below, which RtD itself
|
|
# drives as an incremental PR-preview build. The preflight doctor checks Python
|
|
# 3.11 and the docs lock, and blocks on drift unless you pass
|
|
# RTD_DOCTOR_ARGS=--warn-only.
|
|
rtd-build: rtd-doctor
|
|
@# Remove cached serve API stubs so autosummary regenerates them with correct templates
|
|
find source/serve/api/doc/ -name "ray.serve.*.rst" -delete 2>/dev/null || true
|
|
$(SPHINXBUILD) --keep-going -b html $(ALLRTDSPHINXOPTS) $(BUILDDIR)/html
|
|
@echo
|
|
@echo "RtD-faithful build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
|
|
# Incremental one-shot build for Read the Docs PR previews: restore the latest
|
|
# master build cache, mark only the PR-changed files dirty (load_doc_cache.py +
|
|
# update_cache_env.py), then build once WITHOUT -a/-E so Sphinx reuses the cached
|
|
# environment and rebuilds only those files. Mirrors `local`, but builds once
|
|
# instead of running sphinx-autobuild.
|
|
#
|
|
# No --keep-going: if the restored cache is incompatible (e.g. it predates an
|
|
# autosummary template change and carries stale generated stubs), fail on the
|
|
# first warning so .readthedocs.yaml falls back to rtd-fallback (a clean build)
|
|
# quickly instead of grinding through the whole build first.
|
|
rtd:
|
|
python load_doc_cache.py --ray-dir=$(RAY_DIR)
|
|
@# Remove cached serve API stubs so autosummary regenerates them with correct templates
|
|
find source/serve/api/doc/ -name "ray.serve.*.rst" -delete 2>/dev/null || true
|
|
python update_cache_env.py --ray-dir=$(RAY_DIR)
|
|
@# Build into $(BUILDDIR)/html, where load_doc_cache.py extracted the full prior
|
|
@# site and update_cache_env.py refreshed the output timestamps, so Sphinx rewrites
|
|
@# only the PR-changed pages. Then publish the whole tree to $(HTMLDIR): building
|
|
@# straight into an empty $(HTMLDIR) (RTD's output dir) would emit only the changed
|
|
@# pages and drop the rest of the site.
|
|
$(SPHINXBUILD) -b html $(ALLLOCALSPHINXOPTS) $(BUILDDIR)/html
|
|
@if [ "$(HTMLDIR)" != "$(BUILDDIR)/html" ]; then \
|
|
echo "Publishing $(BUILDDIR)/html -> $(HTMLDIR)"; \
|
|
mkdir -p $(HTMLDIR) && cp -a $(BUILDDIR)/html/. $(HTMLDIR)/; \
|
|
fi
|
|
|
|
# Cold rebuild used by .readthedocs.yaml when the incremental `rtd` build fails.
|
|
# git clean -dfX removes only git-ignored files -- the restored cache's _build tree
|
|
# and all generated source/**/doc stubs -- so the tree matches a fresh checkout,
|
|
# then a full clean build runs (identical to what postmerge CI builds and caches).
|
|
rtd-fallback:
|
|
git clean -dfX .
|
|
$(MAKE) HTMLDIR="$(HTMLDIR)" html
|
|
|
|
dirhtml:
|
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
|
|
singlehtml:
|
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
@echo
|
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
|
|
pickle:
|
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
@echo
|
|
@echo "Build finished; now you can process the pickle files."
|
|
|
|
json:
|
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
@echo
|
|
@echo "Build finished; now you can process the JSON files."
|
|
|
|
htmlhelp:
|
|
$(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."
|
|
|
|
qthelp:
|
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
@echo
|
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Ray.qhcp"
|
|
@echo "To view the help file:"
|
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Ray.qhc"
|
|
|
|
applehelp:
|
|
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
|
@echo
|
|
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
|
@echo "N.B. You won't be able to view it unless you put it in" \
|
|
"~/Library/Documentation/Help or install it in your application" \
|
|
"bundle."
|
|
|
|
devhelp:
|
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
@echo
|
|
@echo "Build finished."
|
|
@echo "To view the help file:"
|
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/Ray"
|
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ray"
|
|
@echo "# devhelp"
|
|
|
|
epub:
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
@echo
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
|
|
latex:
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
@echo
|
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
"(use \`make latexpdf' here to do that automatically)."
|
|
|
|
latexpdf:
|
|
$(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."
|
|
|
|
latexpdfja:
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
|
|
text:
|
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
@echo
|
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
|
|
man:
|
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
@echo
|
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
|
|
texinfo:
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
@echo
|
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
"(use \`make info' here to do that automatically)."
|
|
|
|
info:
|
|
$(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."
|
|
|
|
gettext:
|
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
@echo
|
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
|
|
changes:
|
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
@echo
|
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
|
|
linkcheck:
|
|
$(SPHINXBUILD) -b linkcheck $(ALLLINKCHECKOPTS) $(BUILDDIR)/linkcheck
|
|
@echo
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
|
|
linkcheck_all:
|
|
LINKCHECK_ALL=1 $(SPHINXBUILD) -b linkcheck $(ALLLINKCHECKOPTS) $(BUILDDIR)/linkcheck
|
|
@echo
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
|
|
doctest:
|
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
@echo "Testing of doctests in the sources finished, look at the " \
|
|
"results in $(BUILDDIR)/doctest/output.txt."
|
|
|
|
coverage:
|
|
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
|
@echo "Testing of coverage in the sources finished, look at the " \
|
|
"results in $(BUILDDIR)/coverage/python.txt."
|
|
|
|
xml:
|
|
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
@echo
|
|
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
|
|
pseudoxml:
|
|
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
@echo
|
|
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
|
|
show:
|
|
python -m http.server -d _build/html/
|