summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-10-30 08:02:56 -0400
committerNed Batchelder <ned@nedbatchelder.com>2021-10-30 08:49:12 -0400
commit33f53955332ac3516640c8e898626f4c3107fe9b (patch)
tree46c46f8ee39787bb5490a9b7ec7d92973bed7005
parent0984338df1dd98a1e4fbe4fd3f878f38e9d393a5 (diff)
downloadpython-coveragepy-git-33f53955332ac3516640c8e898626f4c3107fe9b.tar.gz
docs: fix two warnings in the release-notes process
... and change "tox doc" to fail next time this happens.
-rw-r--r--Makefile2
-rw-r--r--doc/changes.rst2
-rw-r--r--tox.ini2
3 files changed, 3 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 1b8c3457..2413f4b4 100644
--- a/Makefile
+++ b/Makefile
@@ -166,7 +166,7 @@ RELNOTES_JSON = tmp/relnotes.json
$(CHANGES_MD): CHANGES.rst $(DOCBIN)
$(SPHINXBUILD) -b rst doc tmp/rst_rst
- pandoc -frst -tmarkdown_strict --atx-headers --wrap=none tmp/rst_rst/changes.rst > $(CHANGES_MD)
+ pandoc -frst -tmarkdown_strict --markdown-headings=atx --wrap=none tmp/rst_rst/changes.rst > $(CHANGES_MD)
relnotes_json: $(RELNOTES_JSON) ## Convert changelog to JSON for further parsing.
$(RELNOTES_JSON): $(CHANGES_MD)
diff --git a/doc/changes.rst b/doc/changes.rst
index 6fb009d0..42af57c7 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -379,7 +379,7 @@ Version 5.0a6 — 2019-07-16
so should only be used between two installations of the same version of
coverage.py.
- - The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new
+ - The :class:`CoverageData constructor<.CoverageData>` has a new
argument, `no_disk` (default: False). Setting it to True prevents writing
any data to the disk. This is useful for transient data objects.
diff --git a/tox.ini b/tox.ini
index ad9d6540..c2b434e4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -64,7 +64,7 @@ commands =
make cmd_help
python doc/check_copied_from.py doc/*.rst
doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst
- sphinx-build -b html -aqE doc doc/_build/html
+ sphinx-build -b html -aEnqW doc doc/_build/html
rst2html.py --strict README.rst doc/_build/trash
- sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html
- sphinx-build -b html -b linkcheck -aEnQW doc doc/_build/html