mkgendocs
mkgendocs copied to clipboard
Not parsing dict examples from docstrings
trafficstars
There is a problem parsing dict examples in docstrings. For example if a have this docstring:
class FlowFactory(Flow):
"""
Bla Bla Bla
!!! example "Example of flow_init configuration"
In the example below ...
flow_init = {
"app_mode": "TEST",
"app_version": "1.0.0",
"config_base_directory": "C:\\workspace\\test_env\\TEST",
"env": "local",
"jsons_dir": "<some_path>",
}
"""
its not parsing that dict. The final result in online documentation is:
flow_init = {
}
I'm using Python 3.9 and latest version of this packages:
mkdocs # static site generator for documentation in Markdown
mkgendocs # generate MkDocs pages from Google-style docstrings of Python functions
mkdocs-material # Material support for MkDocs
mkdocs-minify-plugin # strips whitespaces in HTML markdown documentation pages
mkdocs-git-revision-date-localized-plugin # displays the date of the last git modification of a markdown page
mkdocs-git-authors-plugin # displays git authors of a markdown page
mkdocs-table-reader-plugin # enables automatic CSV imports as a table into a markdown page
mkdocs-img2fig-plugin # converts markdown encoded images to HTML figures
mkdocs-awesome-pages-plugin # enables naive configuration of page titles and their order
mkdocs-enumerate-headings-plugin # enumerates headings across markdown pages
mkdocs-print-site-plugin # allows visiters to File > Print > Save as PDF entire markdown documentation