File tree Expand file tree Collapse file tree 2 files changed +14
-3
lines changed
Expand file tree Collapse file tree 2 files changed +14
-3
lines changed Original file line number Diff line number Diff line change 11SHELL := /bin/bash -euxo pipefail
22
3+ # Treat Sphinx warnings as errors
4+ SPHINXOPTS := -W
5+
36.PHONY : lint
47lint :
58 check-manifest .
@@ -41,3 +44,13 @@ fix-lint:
4144 --exclude src/vws/_version.py \
4245 .
4346 isort --recursive --apply
47+
48+ .PHONY : docs
49+ docs :
50+ make -C docs clean html SPHINXOPTS=$(SPHINXOPTS )
51+
52+ .PHONY : open-docs
53+ open-docs :
54+ xdg-open docs/build/html/index.html > /dev/null 2>&1 || \
55+ open docs/build/html/index.html > /dev/null 2>&1 || \
56+ echo " Requires 'xdg-open' or 'open' but neither is available."
Original file line number Diff line number Diff line change 99import os
1010import sys
1111
12- import mock_vws
12+ import vws
1313
1414sys .path .insert (0 , os .path .abspath ('.' ))
1515
1616extensions = [
1717 'sphinx.ext.autodoc' ,
1818 'sphinx.ext.intersphinx' ,
1919 'sphinx.ext.napoleon' ,
20- 'sphinx_autodoc_typehints' ,
21- 'sphinxcontrib.spelling' ,
2220]
2321
2422templates_path = ['_templates' ]
You can’t perform that action at this time.
0 commit comments