Include additional changes to support blurbified NEWS (#3340)
This commit is contained in:
parent
e295b82609
commit
fcd97d4438
|
@ -43,7 +43,7 @@ matrix:
|
||||||
- cd Doc
|
- cd Doc
|
||||||
# Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures.
|
# Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures.
|
||||||
# (Updating the version is fine as long as no warnings are raised by doing so.)
|
# (Updating the version is fine as long as no warnings are raised by doing so.)
|
||||||
- python -m pip install sphinx~=1.6.1
|
- python -m pip install sphinx~=1.6.1 blurb
|
||||||
script:
|
script:
|
||||||
- make check suspicious html SPHINXOPTS="-q -W -j4"
|
- make check suspicious html SPHINXOPTS="-q -W -j4"
|
||||||
- os: linux
|
- os: linux
|
||||||
|
|
17
Doc/Makefile
17
Doc/Makefile
|
@ -6,6 +6,7 @@
|
||||||
# You can set these variables from the command line.
|
# You can set these variables from the command line.
|
||||||
PYTHON = python3
|
PYTHON = python3
|
||||||
SPHINXBUILD = sphinx-build
|
SPHINXBUILD = sphinx-build
|
||||||
|
BLURB = $(PYTHON) -m blurb
|
||||||
PAPER =
|
PAPER =
|
||||||
SOURCES =
|
SOURCES =
|
||||||
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)
|
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)
|
||||||
|
@ -38,6 +39,20 @@ help:
|
||||||
@echo " serve to serve the documentation on the localhost (8000)"
|
@echo " serve to serve the documentation on the localhost (8000)"
|
||||||
|
|
||||||
build:
|
build:
|
||||||
|
-mkdir -p build
|
||||||
|
# Look first for a Misc/NEWS file (building from a source release tarball
|
||||||
|
# or old repo) and use that, otherwise look for a Misc/NEWS.d directory
|
||||||
|
# (building from a newer repo) and use blurb to generate the NEWS file.
|
||||||
|
@if [ -f ../Misc/NEWS ] ; then \
|
||||||
|
echo "Using existing Misc/NEWS file"; \
|
||||||
|
cp ../Misc/NEWS build/NEWS; \
|
||||||
|
elif [ -d ../Misc/NEWS.d ]; then \
|
||||||
|
echo "Building NEWS from Misc/NEWS.d with blurb"; \
|
||||||
|
$(BLURB) merge -f build/NEWS; \
|
||||||
|
else \
|
||||||
|
echo "Neither Misc/NEWS.d nor Misc/NEWS found; cannot build docs"; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
$(SPHINXBUILD) $(ALLSPHINXOPTS)
|
$(SPHINXBUILD) $(ALLSPHINXOPTS)
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
@ -107,7 +122,7 @@ clean:
|
||||||
|
|
||||||
venv:
|
venv:
|
||||||
$(PYTHON) -m venv venv
|
$(PYTHON) -m venv venv
|
||||||
./venv/bin/python3 -m pip install -U Sphinx
|
./venv/bin/python3 -m pip install -U Sphinx blurb
|
||||||
|
|
||||||
dist:
|
dist:
|
||||||
rm -rf dist
|
rm -rf dist
|
||||||
|
|
|
@ -4,4 +4,4 @@
|
||||||
Changelog
|
Changelog
|
||||||
+++++++++
|
+++++++++
|
||||||
|
|
||||||
.. miscnews:: ../../Misc/NEWS
|
.. miscnews:: ../build/NEWS
|
||||||
|
|
Loading…
Reference in New Issue