api development documentation
add documentation for development, in particular python api (docstrings) to aid in development.
example for mkdocs.yaml
plugins:
- mkdocstrings:
enabled: true
handlers:
python:
setup_commands:
- import os
- import django
- os.chdir('app/')
- os.environ.setdefault("DJANGO_SETTINGS_MODULE", "app.settings")
- django.setup()
options:
find_stubs_package: true
heading_level: 3
members_order: source
show_if_no_docstring: true
# show_inheritance_diagram: true
# show_root_heading: true
show_root_full_path: true
show_root_toc_entry: true
show_labels: false
show_source: false
show_submodules: true
summary: true
# inherited_members: true
paths: [ '.' ]
parameter_headings: false