Contributions are more than welcome! Don't hesitate to open an incomplete PR to ask for help!
The library currently supports Python versions 3.6+
Just run tox
tox
python -m pytest tests
(Or python3 -m pytest tests if you still have Python 2 laying around)
Just copy one of the existing template, change the name and start modifying.
If you are looking for examples, you can run generate_examples.py from the docs folder, after changing this line tp add your template name:
config = GenerationConfiguration(deprecated_from_description=True, expand_buttons=True, template_name="my_new_template")The examples will be in docs/assets/examples
The maintainer will take care of the following for you if you don't want to bother with it :)
Running with tox will ensure the code has been formatted with black
It is recommended to run black from your IDE or as a pre-commit hook
schema_doc.js is not minified automatically, you are responsible for doing it yourself
The documentation is generated using jekyll and hosted on GitHub Pages
- Change your current working directory to
docs - Run
python generate_examples.py. This will get all examples fromtests/cases, render the resulting HTML and include it in the appropriate folders in the jekyll site. - If you have added an example, add the file name (without
.json), the display name and description in_data/examples.yaml