Simplify doc/Makefile with sphinx-build make-mode #3761
Merged
Conversation
This file contains 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
seisman
commented
Jan 9, 2025
| @echo | ||
| # Set PYGMT_USE_EXTERNAL_DISPLAY to "false" to disable external display | ||
| PYGMT_USE_EXTERNAL_DISPLAY="false" $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| PYGMT_USE_EXTERNAL_DISPLAY="false" $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) |
There was a problem hiding this comment.
$@ is the target, i.e., html when running make html.
seisman
force-pushed
the
maintenance/sphinx-make
branch
from
5b132d1 to
410b8e7
Compare
seisman
commented
Jan 9, 2025
| @@ -28,20 +26,20 @@ api: | |||
| @echo | |||
| $(SPHINXAUTOGEN) -i -t _templates -o api/generated api/*.rst | |||
|
|
|||
| html: api | |||
| html latex: api | |||
There was a problem hiding this comment.
latex is added here to support PDF documentation (xref #1606).
seisman
added
skip-changelog
michaelgrund
approved these changes
Jan 10, 2025
seisman
added
final review call
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
sphinx-buildstarted to provide the so-called make-mode since v1.2.0, which has been the default mode since v1.5.0.Here is a simple comparison for the make-mode and the "normal" mode:
Old normal mode:
make mode:
These two modes are very similar, but in make-mode, we use
$(BUILDDIR)not$(BUILDDIR)/html.A good advantage is that we can use the same command for different Sphinx builders.
This PR updates
doc/Makefilewith the make-mode and also adds thelatextarget to generate LaTeX source files.Address #1606.