diff options
author | Jelmer Vernooij <jelmer@jelmer.uk> | 2022-01-24 19:51:14 +0000 |
---|---|---|
committer | Jelmer Vernooij <jelmer@jelmer.uk> | 2022-01-24 19:59:38 +0000 |
commit | 2442ca249c7675a990fd23f1497936f8c16eb90a (patch) | |
tree | bfaefc5fa28fce0dd7e5e07e0fa9fa79eec033bc | |
parent | 8d207b725e1a23c71e4e7306336441fa894e2c21 (diff) | |
download | testtools-2442ca249c7675a990fd23f1497936f8c16eb90a.tar.gz |
Add instructions on building docs. Fixes #305
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | README.rst | 3 |
2 files changed, 4 insertions, 1 deletions
@@ -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 @@ -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 --------- |