This is a C extension for hotdoc

This extension uses clang to generate symbols for C source code, and implements its own comment scanner, to speed things up in situations where the relevant comments are explicitly named, and the user doesn't need to document static functions.

This extension uses the bindings of clang. It has been tested with clang-3.5 and clang 3.6.2, but it might work with other clang versions.

To figure out the clang bindings that need to be installed, hotdoc also needs the "llvm-config" program to be in the PATH.

This extension also uses flex for the comment scanner.

On Fedora 22 the dependencies can be installed with:

dnf install clang-devel llvm-devel flex python-devel

On a recent enough Debian / Ubuntu:

apt-get install libclang-dev llvm-dev flex python-dev

Otherwise you may still try to install an earlier version of clang with

apt-get install libclang-dev llvm-dev flex python-dev

If you use this extension in another environment, please let me know how you installed these requirements :)

You can then install this extension either through pip:

pip install hotdoc_c_extension

Or with setup.py if you checked out the code from git:

python setup.py install

This will of course work in a virtualenv as well.

Just run hotdoc's wizard for more information once the extension is installed with:

hotdoc conf --quickstart

Checkout the code from github, then run:

python setup.py develop

hotdoc's C extension is licensed under the LGPL version 2.1 (or, at your option, any later version). See COPYING for more details.