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 .
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages .
Source Distribution
Built Distribution
File details
Details for the file mkdocstrings_vba-0.0.9.tar.gz
.
File metadata
Download URL: mkdocstrings_vba-0.0.9.tar.gz
Upload date: Sep 19, 2024
Size: 19.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Hashes for mkdocstrings_vba-0.0.9.tar.gz
Algorithm
Hash digest
SHA256
c434a36457cb4ccea55d8a38401ff79322ae3e6678db0e3eb3b0c1be49a0973a
Copy
MD5
a2d0a084720ba3bc6df08d982dcd5bdc
Copy
BLAKE2b-256
1eded6a1e3d6af80b0f91f4c4c1b51eb3f0a6ac8999a78cb5f815f6180c3c3db
Copy
See more details on using hashes here.
File details
Details for the file mkdocstrings_vba-0.0.9-py3-none-any.whl
.
File metadata
File hashes
Hashes for mkdocstrings_vba-0.0.9-py3-none-any.whl
Algorithm
Hash digest
SHA256
961e5abc1f1b798ba8e89e2707fac425807d9cb52cd90bf7c6db7f7e978dbba9
Copy
MD5
edeb9f1b23363abe931df0b4338f67e5
Copy
BLAKE2b-256
1ff32c38d1c59488704f4c9534835a386eb04eada0ce1e86365c2e039daca268
Copy
See more details on using hashes here.