Skip to main content

A documentation tool based on clang

Project description

![Hotdoc logo](https://cdn.rawgit.com/MathieuDuponchelle/hotdoc/develop/documentation/hotdoc.svg)

This project needs a logo. In the meantime, eyes will get hurt by this
horrible illustration of programmer art.

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 ...)
* Themeability (see [this example](https://github.com/MathieuDuponchelle/hotdoc_bootstrap_theme/commits/master)
* Persisting of the documentation through sqlalchemy, with an API to access it.
An example project that uses this API is the hotdoc server, which will soon be made public.
+ Many more things !

### Additional resources (FIXME: update extensions, outdated)

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

hotdoc-0.5.9.6.tar.gz (294.8 kB view details)

Uploaded Source

File details

Details for the file hotdoc-0.5.9.6.tar.gz.

File metadata

  • Download URL: hotdoc-0.5.9.6.tar.gz
  • Upload date:
  • Size: 294.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hotdoc-0.5.9.6.tar.gz
Algorithm Hash digest
SHA256 5220e7ecaecf4c1207e32ec4b3c35a9276a4abf1652c87b262a8023f70f33126
MD5 2af1a3f5e52559db69e3bf20bd61f269
BLAKE2b-256 4f9cc5683b6d815d1f7d3dc3a46ac63e5cc423efbed078d286c77c7bea9d27e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page