Skip to content

Commit 437f400

Browse files
committed
Add makefile items
1 parent 1499016 commit 437f400

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

Makefile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
SHELL := /bin/bash -euxo pipefail
22

3+
# Treat Sphinx warnings as errors
4+
SPHINXOPTS := -W
5+
36
.PHONY: lint
47
lint:
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."

docs/source/conf.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,14 @@
99
import os
1010
import sys
1111

12-
import mock_vws
12+
import vws
1313

1414
sys.path.insert(0, os.path.abspath('.'))
1515

1616
extensions = [
1717
'sphinx.ext.autodoc',
1818
'sphinx.ext.intersphinx',
1919
'sphinx.ext.napoleon',
20-
'sphinx_autodoc_typehints',
21-
'sphinxcontrib.spelling',
2220
]
2321

2422
templates_path = ['_templates']

0 commit comments

Comments
 (0)