A VBA handler for mkdocstrings.
Since there is no official way of documenting VBA functions, we have opted for
the Google Docstring format commonly used
in Python projects. This is conveniently parsed by the griffe
library which
is also used by mkdocstrings[python]
. The argument types and return types
are taken from the
VBA Function
or Sub signatures,
which we parse using regex.
See the examples
folder.
To build an example site:
pip install mkdocstrings mkdocstrings-vba
cd examples/example1
mkdocs build
site/
pip install -r test-requirements.txt
python -m unittest
This will run all tests. This includes
tests/
.mkdocstrings_vba/
.examples/
.Fix code style using black
:
black .
Check types using mypy
:
mypy .