summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@jelmer.uk>2022-01-24 19:51:14 +0000
committerJelmer Vernooij <jelmer@jelmer.uk>2022-01-24 19:59:38 +0000
commit2442ca249c7675a990fd23f1497936f8c16eb90a (patch)
treebfaefc5fa28fce0dd7e5e07e0fa9fa79eec033bc
parent8d207b725e1a23c71e4e7306336441fa894e2c21 (diff)
downloadtesttools-2442ca249c7675a990fd23f1497936f8c16eb90a.tar.gz
Add instructions on building docs. Fixes #305
-rw-r--r--Makefile2
-rw-r--r--README.rst3
2 files changed, 4 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index c637123..6f88b3f 100644
--- a/Makefile
+++ b/Makefile
@@ -50,7 +50,7 @@ clean-sphinx:
# Build the html docs using Sphinx.
html-sphinx:
- cd doc && make html
+ cd doc && PYTHONPATH=.. make html
.PHONY: apidocs docs-sphinx clean-sphinx html-sphinx docs
.PHONY: check clean prerelease release
diff --git a/README.rst b/README.rst
index 68dc498..df8302d 100644
--- a/README.rst
+++ b/README.rst
@@ -16,6 +16,9 @@ If you would like to learn more about testtools, consult our documentation in
the 'doc/' directory. You might like to start at 'doc/overview.rst' or
'doc/for-test-authors.rst'.
+To build HTML versions of the documentation, make sure you have
+sphinx installed and run ``make docs``.
+
Licensing
---------