Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce striter CI checks for docs and fix some doc issues that would now fail the build. #1437

Merged
merged 3 commits into from
Sep 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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."

Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ethpm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ Sample standard-json-input.json
"language": "Solidity",
"sources": {
"Contract.sol": {
"urls": [<path-to-contract>]
"urls": ["<path-to-contract>"]
}
},
"settings": {
Expand Down
5 changes: 5 additions & 0 deletions newsfragments/1437.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +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.