Skip to main content

Automatically generate API documentation for C language dialects

Project description

clang-api-doc

Generate C API documentation using libclang Python bindings.

For an example see the documentation.

Usage

Simply call clang-api-doc once per file you wish to document, e.g.

clang-api-doc -f 'include/mylib/first.h' -o 'first.md'
clang-api-doc -f 'include/mylib/second.h' -o 'second.md'

These files can then be used in any way you wish to create your final documentation, for example

  • transform to a different format using pandoc
  • write an index.md file and use sphinx to create html docs

Installation

The clang-api-doc package is on PyPI, so you can use pip, poetry, or whatever you like to install it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for clang-api-doc, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size clang_api_doc-0.2.0-py3-none-any.whl (14.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size clang-api-doc-0.2.0.tar.gz (4.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page