Skip to content
Snippets Groups Projects
Select Git revision
  • parser default protected
1 result
Compare
Hugo Hörnquist's avatar
Major documentation for doc DocStringTag.
Hugo Hörnquist authored 
Extend DocStringTag to include "all" known types, along with document
how each of them behaves. This also forced a few changes to its
behaviour, which is reflected in the updated tests. The biggest change
is that we now barely test for valid "tag_name" values, since a valid
tag should always have a valid (albeit unknown) tag name.
4d8814c7
History
Hugo Hörnquist's avatar 4d8814c7
History
Name Last commit Last update
doc
json-test
muppet
static-src
static
templates
tests
.flake8
.gitignore
LICENSE
Makefile
README.md
mypy.ini
setup.cfg
setup.py
README.md

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)

make clean all

Running the tests

make check  # Run linters
make test   # Run unit tests

Coverage information will end up in htmlcov/.

Building the documentation

make documentation

Documentation will end up in doc.rendered/.

Dependencies

General python dependencies are documented in ./setup.cfg.

Runtime dependencies

  • Puppet
  • Puppet Strings

Testing dependencies

  • flake8
  • mypy
  • pytest

Documentation dependencies

  • sphinx