README.md

mkdocstring-parser

This repo creates a simple parser for mkdocstrings. The idea is simple, given a mkdocstrings signature block, replace it with it rendered markdown in-place.

To view the complete guide on generating Nixtlaverse documentation, click here

example

# title

::: my_module.my_function

gets rendered as

# title

```py
def my_function(a, b):
    ...
    ...
    # and so on
```

to run the code

python parser.py

cases to be mindful of while creating tests for the parser

• class with no public methods (datasetsforecast.favorita.CodeTimer)
  • it documents the instance variables then
• dataclass
• pure functions
• pure functions (with decorator-based docstring)