Metadata-Version: 2.1
Name: docblock
Version: 0.0.1a0
Summary: Reads and parses documentation from C++ header files in pure Python.
Home-page: https://github.com/N-Wouda/docblock
License: MIT
Author: Niels Wouda
Author-email: nielswouda@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Requires-Dist: pyparsing (>=3.0.6,<4.0.0)
Project-URL: Repository, https://github.com/N-Wouda/docblock
Project-URL: Tracker, https://github.com/N-Wouda/docblock/issues
Description-Content-Type: text/markdown

# docblock

[![CI](https://github.com/N-Wouda/docblock/actions/workflows/CI.yaml/badge.svg?branch=main)](https://github.com/N-Wouda/docblock/actions/workflows/CI.yaml)
[![codecov](https://codecov.io/gh/N-Wouda/docblock/branch/main/graph/badge.svg?token=SWFVP2J84T)](https://codecov.io/gh/N-Wouda/docblock)

The `docblock` package reads and parses documentation from C++ header files. 
It is opinionated and explicitly does *not* cover all edge cases of the C++ grammar, but hopes to provide sufficient utility for most use cases.
The `docblock` package is a pure Python package and depends only on `pyparsing`.
It can be installed as
```shell
pip install docblock
``` 

## Why `docblock`?

TODO

## Example usage

TODO

