diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-06-03 22:26:56 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-06-03 22:26:56 +0200 |
commit | 7981a7a13756bc34acf441ddf04f138571b7076c (patch) | |
tree | 51532048e4678f60f3bda35e400d729017a53527 /README.md | |
parent | Introduce summaries for class list. (diff) | |
download | muppet-strings-7981a7a13756bc34acf441ddf04f138571b7076c.tar.gz muppet-strings-7981a7a13756bc34acf441ddf04f138571b7076c.tar.xz |
Setup sphinx documentation.
Documentation can now be generated to HTML through sphinx.
Some docstrings have been updated to be on the correct format.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -9,6 +9,24 @@ environments. Usage ----- +### Building the example (probably broken for you) + ```bash make clean all ``` + +### Running the tests + +```bash +make check # Run linters +make test # Run unit tests +``` + +Coverage information will end up in `htmlcov/`. + +### Building the documentation +```bash +make documentation +``` + +Documentation will end up in `doc.rendered/`. |