mkdocstrings-vba

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.

Examples

See the examples folder.

To build an example site:

1. pip install mkdocstrings mkdocstrings-vba
2. cd examples/example1
3. View the source code.
4. mkdocs build
5. cd site/
6. View the results.

Running tests

pip install -r test-requirements.txt
python -m unittest

This will run all tests. This includes

• Unit tests from tests/.
• Doctests from mkdocstrings_vba/.
• Full builds from examples/.

Linting

Fix code style using black:

black .

Check types using mypy:

mypy .