This is the (new) documentation for preseq that uses mkdocs to generate readthedocs pages. The public web verison of this documentation is available at preseq.readthedocs.io, but for users who wish to see the documentation on a web browser offline, you can build the documentation locally as described below.

To build the documentation locally, install mkdocs

pip install -U mkdocs

Build the HTML documentation by running

mkdocs build

which will create a site directory where markdown files are converted to HTML

Create a local host for the HTML documentation by running

mkdocs serve

This will create the documentation, usually at http://localhost:8000 .