8000 Switch to using blurb to manage Misc/NEWS! · stackless-dev/stackless@f067f7e · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Commit f067f7e

Browse files
larryhastingslarryhastings
committed
Switch to using blurb to manage Misc/NEWS!
1 parent b154917 commit f067f7e

39 files changed

+32268
-10645
lines changed

‎Doc/Makefile

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,24 @@
44
#
55

66
# You can set these variables from the command line.
7-
PYTHON = python
7+
PYTHON = python3
88
SPHINXBUILD = sphinx-build
9+
BLURB = $(PYTHON) -m blurb
9< 8000 /td>10
PAPER =
1011
SOURCES =
1112
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)
1213

13-
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
14+
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_elements.papersize=$(PAPER) \
1415
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
1516

1617
.PHONY: help build html htmlhelp latex text changes linkcheck \
1718
suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
18-
autobuild-dev autobuild-stable
19+
autobuild-dev autobuild-stable venv
1920

2021
help:
2122
@echo "Please use \`make <target>' where <target> is one of"
2223
@echo " clean to remove build files"
24+
@echo " venv to create a venv with necessary tools"
2325
@echo " html to make standalone HTML files"
2426
@echo " htmlview to open the index page built by the html target in your browser"
2527
@echo " htmlhelp to make HTML files and a HTML help project"
@@ -37,6 +39,8 @@ help:
3739
@echo " serve to serve the documentation on the localhost (8000)"
3840

3941
build:
42+
-mkdir -p build
43+
$(BLURB) merge -f build/NEWS
4044
$(SPHINXBUILD) $(ALLSPHINXOPTS)
4145
@echo
4246

@@ -102,7 +106,11 @@ htmlview: html
102106
$(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
103107

104108
clean:
105-
-rm -rf build/*
109+
-rm -rf build/* venv/*
110+
111+
venv:
112+
$(PYTHON) -m venv venv
113+
./venv/bin/python3 -m pip install -U Sphinx
106114

107115
dist:
108116
rm -rf dist
@@ -148,21 +156,26 @@ dist:
148156
cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub
149157

150158
check:
151-
$(PYTHON) tools/rstlint.py -i tools
159+
$(PYTHON) tools/rstlint.py -i tools -i venv -i README.rst
152160

153161
serve:
154162
../Tools/scripts/serve.py build/html
155163

156164
# Targets for daily automated doc build
165+
# By default, Sphinx only rebuilds pages where the page content has changed.
166+
# This means it doesn't always pick up changes to preferred link targets, etc
167+
# To ensure such changes are picked up, we build the published docs with
168+
# `-E` (to ignore the cached environment) and `-a` (to ignore already existing
169+
# output files)
157170

158171
# for development releases: always build
159172
autobuild-dev:
160-
make dist SPHINXOPTS='-A daily=1 -A versionswitcher=1'
173+
make dist SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1'
161174
-make suspicious
162175

163176
# for quick rebuilds (HTML only)
164177
autobuild-dev-html:
165-
make html SPHINXOPTS='-A daily=1 -A versionswitcher=1'
178+
make html SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1'
166179

167180
# for stable releases: only build if not in pre-release stage (alpha, beta)
168181
# release candidate downloads are okay, since the stable tree can be in that stage

‎Doc/whatsnew/changelog.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
.. _changelog:
2+
13
+++++++++
24
Changelog
35
+++++++++
46

5-
.. miscnews:: ../../Misc/NEWS
7+
.. miscnews:: ../build/NEWS

0 commit comments

Comments
 (0)
0