-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
doc/en/Makefile: use Sphinx's make mode #6873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -4,13 +4,20 @@ | |||||
# You can set these variables from the command line. | ||||||
SPHINXOPTS = | ||||||
SPHINXBUILD = sphinx-build | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
PAPER = | ||||||
SOURCEDIR = . | ||||||
BUILDDIR = _build | ||||||
|
||||||
# Internal variables. | ||||||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||||||
PAPEROPT_letter = -D latex_paper_size=letter | ||||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||||||
# Put it first so that "make" without argument is like "make help". | ||||||
help: | ||||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||||||
|
||||||
.PHONY: help Makefile | ||||||
|
||||||
# Catch-all target: route all unknown targets to Sphinx using the new | ||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||||||
%: Makefile | ||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||||||
|
||||||
|
||||||
REGENDOC_ARGS := \ | ||||||
--normalize "/[ \t]+\n/\n/" \ | ||||||
|
@@ -25,130 +32,8 @@ REGENDOC_ARGS := \ | |||||
--normalize "@hypothesis-(\d+)\\.[.\d,]+@hypothesis-\1.x.y@" \ | ||||||
--normalize "@Python (\d+)\\.[^ ,]+@Python \1.x.y@" | ||||||
|
||||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest | ||||||
|
||||||
|
||||||
help: | ||||||
@echo "Please use \`make <target>' where <target> is one of" | ||||||
@echo " html to make standalone HTML files" | ||||||
@echo " latexpdf to make LaTeX files and run them through pdflatex" | ||||||
@echo " showtarget to show the pytest.org target directory" | ||||||
@echo " install to install docs to pytest.org/SITETARGET" | ||||||
@echo " install-ldf to install the doc pdf to pytest.org/SITETARGET" | ||||||
@echo " regen to regenerate pytest examples using the installed pytest" | ||||||
@echo " linkcheck to check all external links for integrity" | ||||||
|
||||||
clean: | ||||||
-rm -rf $(BUILDDIR)/* | ||||||
|
||||||
regen: REGENDOC_FILES:=*.rst */*.rst | ||||||
regen: | ||||||
PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS="-pno:hypothesis -Wignore::pytest.PytestUnknownMarkWarning" COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS} | ||||||
|
||||||
html: | ||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||||||
@echo | ||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/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/pytest.qhcp" | ||||||
@echo "To view the help file:" | ||||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest.qhc" | ||||||
|
||||||
devhelp: | ||||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||||||
@echo | ||||||
@echo "Build finished." | ||||||
@echo "To view the help file:" | ||||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/pytest" | ||||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest" | ||||||
@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." | ||||||
|
||||||
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." | ||||||
|
||||||
changes: | ||||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||||||
@echo | ||||||
@echo "The overview file is in $(BUILDDIR)/changes." | ||||||
|
||||||
linkcheck: | ||||||
$(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." | ||||||
|
||||||
doctest: | ||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||||||
@echo "Testing of doctests in the sources finished, look at the " \ | ||||||
"results in $(BUILDDIR)/doctest/output.txt." | ||||||
|
||||||
texinfo: | ||||||
mkdir -p $(BUILDDIR)/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: | ||||||
mkdir -p $(BUILDDIR)/texinfo | ||||||
$(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." | ||||||
.PHONY: regen |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.