MkDocstrings VBA handler
Project description
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:
pip install mkdocstrings mkdocstrings-vba
cd examples/example1
- View the source code.
mkdocs build
- cd
site/
- 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 .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocstrings-vba-0.0.8.tar.gz
(19.3 kB
view hashes)
Built Distribution
Close
Hashes for mkdocstrings_vba-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5fbe8fecbf9e50f6da39b83d9fa4c08558e0fefcc5ffdd6c6deb25f0968ac52 |
|
MD5 | c573c14c11dd74ecd07aa01575eea901 |
|
BLAKE2b-256 | 552fe5c124af7563844a60f96962a6c15d18a7cd0b43e1ffab105f50672016ac |