From ea210b80dfa7d94358313f707ec69989283a4c1a Mon Sep 17 00:00:00 2001 From: Christoph Burgdorf Date: Tue, 27 Aug 2019 10:44:22 +0200 Subject: [PATCH 1/3] Enforce stricter CI checks for docs --- docs/Makefile | 2 +- newsfragments/1437.doc.rst | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 newsfragments/1437.doc.rst diff --git a/docs/Makefile b/docs/Makefile index d8fd926f52..f00bded9c1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -50,7 +50,7 @@ clean: rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + $(SPHINXBUILD) -W -T -E -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/newsfragments/1437.doc.rst b/newsfragments/1437.doc.rst new file mode 100644 index 0000000000..e0e33c4324 --- /dev/null +++ b/newsfragments/1437.doc.rst @@ -0,0 +1,2 @@ +Enforce stricter doc checking, turning warnings into errors to fail CI builds +to catch issues quickly. From 2ef5c9e6089a07dd3b1b00d425ac285ce3d46234 Mon Sep 17 00:00:00 2001 From: Christoph Burgdorf Date: Tue, 27 Aug 2019 10:45:14 +0200 Subject: [PATCH 2/3] Add missing doc to TOC and fix badly formatted example --- docs/ethpm.rst | 2 +- docs/index.rst | 1 + newsfragments/1437.doc.rst | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/ethpm.rst b/docs/ethpm.rst index 11a55e3763..3b2957e810 100644 --- a/docs/ethpm.rst +++ b/docs/ethpm.rst @@ -488,7 +488,7 @@ Sample standard-json-input.json "language": "Solidity", "sources": { "Contract.sol": { - "urls": [] + "urls": [""] } }, "settings": { diff --git a/docs/index.rst b/docs/index.rst index 73f54c8afa..65255fd994 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Contents web3.miner web3.geth web3.parity + web3.tools gas_price ens ethpm diff --git a/newsfragments/1437.doc.rst b/newsfragments/1437.doc.rst index e0e33c4324..a4961f68e8 100644 --- a/newsfragments/1437.doc.rst +++ b/newsfragments/1437.doc.rst @@ -1,2 +1,5 @@ Enforce stricter doc checking, turning warnings into errors to fail CI builds to catch issues quickly. + +Add missing ``web3.tools.rst`` to the table of contents and fix incorrectly formatted +JSON example. \ No newline at end of file From 4b556e057b9cf1b685854a94c4888f2571051b5f Mon Sep 17 00:00:00 2001 From: Keri Date: Thu, 5 Sep 2019 12:04:36 -0600 Subject: [PATCH 3/3] Remove web3.tools from TOC, and add to exclude patterns --- docs/conf.py | 1 + docs/index.rst | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 0929c5dba6..1aaf119408 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -89,6 +89,7 @@ 'web3.providers.rst', 'web3.providers.eth_tester.rst', 'web3.testing.rst', + 'web3.tools.*', ] # The reST default role (used for this markup: `text`) to use for all diff --git a/docs/index.rst b/docs/index.rst index 65255fd994..73f54c8afa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,6 @@ Contents web3.miner web3.geth web3.parity - web3.tools gas_price ens ethpm