Skip to content

Commit 33f5395

Browse files
committed
docs: fix two warnings in the release-notes process
... and change "tox doc" to fail next time this happens.
1 parent 0984338 commit 33f5395

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ RELNOTES_JSON = tmp/relnotes.json
166166

167167
$(CHANGES_MD): CHANGES.rst $(DOCBIN)
168168
$(SPHINXBUILD) -b rst doc tmp/rst_rst
169-
pandoc -frst -tmarkdown_strict --atx-headers --wrap=none tmp/rst_rst/changes.rst > $(CHANGES_MD)
169+
pandoc -frst -tmarkdown_strict --markdown-headings=atx --wrap=none tmp/rst_rst/changes.rst > $(CHANGES_MD)
170170

171171
relnotes_json: $(RELNOTES_JSON) ## Convert changelog to JSON for further parsing.
172172
$(RELNOTES_JSON): $(CHANGES_MD)

doc/changes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ Version 5.0a6 — 2019-07-16
379379
so should only be used between two installations of the same version of
380380
coverage.py.
381381

382-
- The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new
382+
- The :class:`CoverageData constructor<.CoverageData>` has a new
383383
argument, `no_disk` (default: False). Setting it to True prevents writing
384384
any data to the disk. This is useful for transient data objects.
385385

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ commands =
6464
make cmd_help
6565
python doc/check_copied_from.py doc/*.rst
6666
doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst
67-
sphinx-build -b html -aqE doc doc/_build/html
67+
sphinx-build -b html -aEnqW doc doc/_build/html
6868
rst2html.py --strict README.rst doc/_build/trash
6969
- sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html
7070
- sphinx-build -b html -b linkcheck -aEnQW doc doc/_build/html

0 commit comments

Comments
 (0)