A documentation tool based on clang
Project description
# HotDoc
The tastiest documentation system
Read [this](documentation/setup.markdown) if you just want to use hotdoc.
###Overview
HotDoc aims at being a highly modular API documentation tool / library for C and C++ libraries (initially).
It is based on clang for the source code parsing, and CommonMark for the formatting.
It was previously based on pandoc, and a pandoc backend will be available again soon, but the dependency tree with a hard pandoc dependency was just too deep.
It features:
An incremental build system, that only rebuilds the output depending on the changed resources
A pretty comprehensive extension system, handmade and bound to be subjected to API breakage until the 1.0 version of hotdoc is released
A built-in gobject-introspection extension, which will expose gobject-specific concepts (properties, signals, annotations …)
Many more things !
### Interesting resources
[Overview of the rendering design](documentation/design.markdown)
[Dependencies](documentation/dependencies.markdown)
[Porting from gtk-doc](documentation/porting.markdown)
### Additional resources
Check out the [HotDoc extensions](https://github.com/MathieuDuponchelle/hotdoc_extensions)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file hotdoc-0.4.1.tar.gz.
File metadata
- Download URL: hotdoc-0.4.1.tar.gz
- Upload date:
- Size: 70.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e948a0e822e492aac1f3b7885f7abc1e5023182d1c06546a4c8f3342ec3cddd
|
|
| MD5 |
c3022192a0a6da03b9719b0f1d878880
|
|
| BLAKE2b-256 |
8ec531d7b93d1e63bb3c9a855afb337ee1dfcd16c107226d316266391f435d63
|