Metadata-Version: 2.4
Name: clangquill
Version: 0.1.1
Summary: Parse Doxygen-documented C++ with libclang and generate MyST Markdown API docs for Sphinx
Author-Email: clangquill <rene@fritze.me>
License-Expression: BSD-2-Clause
License-File: LICENSE
License-File: LICENSE-LLVM.txt
Classifier: Programming Language :: Python :: 3 :: Only
Project-URL: Documentation, https://renefritze.github.io/clangquill/
Project-URL: Source, https://github.com/renefritze/clangquill
Requires-Python: >=3.13
Requires-Dist: rich
Requires-Dist: packaging
Requires-Dist: typer
Requires-Dist: click
Requires-Dist: jinja2>=3.1
Provides-Extra: docs
Requires-Dist: sphinx>=6; extra == "docs"
Requires-Dist: sphinx-autoapi>=3; extra == "docs"
Requires-Dist: myst-nb>=0.18; extra == "docs"
Requires-Dist: furo>=2023.9.10; extra == "docs"
Provides-Extra: ci
Requires-Dist: pytest; extra == "ci"
Requires-Dist: pytest-cov; extra == "ci"
Provides-Extra: dev
Requires-Dist: ty; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-pycharm; extra == "dev"
Requires-Dist: pytest-regressions; extra == "dev"
Requires-Dist: pytest-datadir; extra == "dev"
Requires-Dist: clangquill[docs]; extra == "dev"
Description-Content-Type: text/markdown

clangquill
=========

![ClangQuill Logo](https://raw.githubusercontent.com/renefritze/clangquill/main/docs/_static/clangquill-logo.png)

[![image](https://github.com/renefritze/clangquill/workflows/pytest/badge.svg)](https://github.com/renefritze/clangquill/actions)


Parse Doxygen-documented C++ with libclang and generate MyST Markdown API docs for Sphinx


Features
--------

-   TODO

Building from source
--------------------

`clangquill` ships a compiled C++ core (`clangquill._core`) built with
[scikit-build-core](https://scikit-build-core.readthedocs.io/), CMake and
[nanobind](https://nanobind.readthedocs.io/). A standard install builds it:

```console
$ pip install .
$ python -c "from clangquill import _core; print(_core.have_libclang())"
```

The core optionally links **libclang**; when `libclang-dev` (or an LLVM prefix
via `LibClang_ROOT`) is available at build time the extraction backend is
enabled. Pass `-DCLANGQUILL_WITH_LIBCLANG=ON` to require it.

After generating your project
-----------------------------

- setup branch protection+automerge in [github project settings](https://github.com/renefritze/clangquill/settings/branches)
- request install for the codecov.io app in [github project settings](https://github.com/renefritze/clangquill/settings/installations)
- configure codecov.io in [codecov.io settings](https://codecov.io/gh/renefritze/clangquill/settings)
- add the `CODECOV_TOKEN` secret in [github project settings](https://github.com/renefritze/clangquill/settings/secrets/actions)


Credits
-------

This package was created with
[Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[renefritze/python_cookiecutter](https://github.com/renefritze/python_cookiecutter)
project template.
