Skip to content

Documentation Generation

Generate documentation for configuration classes as a markdown file or print to the terminal:

python -m essex_config.doc_gen <name-of-your-package> <ConfigurationClass1> <ConfigurationClass2> ...

Add the --output option to specify a markdown file.

Example of the markdown can be found in CONFIG_EXAMPLE.md