Writing documentation

To build the documentation issue the make dirhtml command from the docs directory:

cd docs
make dirhtml

When the build finishes you can view the documentation by running a static web server in the newly generated _build/dirhtml directory. For example:

cd _build/dirhtml; python -m SimpleHTTPServer; cd -

API Documentation

The Hypothesis API documentation is rendered using ReDoc, a JavaScript tool for generating OpenAPI/Swagger reference documentation.

The documentation-building process above will regenerate API documentation output without intervention, but if you are making changes to an API description document (e.g. hypothesis-v1.yaml for v1 on the API),you may find it convenient to use the ReDoc CLI tool, which can watch the spec file for changes:

npm install -g redoc-cli
redoc-cli serve [path-to-description-document] --watch