blob: 448feca8e240596ead12001cdc594d6aafaaee1b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
Muppet Strings
==============
*Like puppet strings, but for multiple modules.*
Utility for building hyperlinked and pretty doc from Puppet modules and
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/`.
Dependencies
------------
General python dependencies are documented in [./setup.cfg](`setup.cfg`).
### Runtime dependencies
- Puppet
- Puppet Strings
### Testing dependencies
- `flake8`
- `mypy`
- `pytest`
### Documentation dependencies
- sphinx
|
