mirror of
https://github.com/libgit2/libgit2.git
synced 2026-01-25 02:56:17 +00:00
89cc5ef8e8
libgit2 has a new documentation generator that generates API schema from our headers, then produces reference documentation that is included into the website directly.
14 lines
513 B
Markdown
14 lines
513 B
Markdown
# API Documentation Generator
|
|
|
|
These scripts generate the "raw API" specs and reference documentation
|
|
for [www.libgit2.org](https://libgit2.org/docs/reference).
|
|
|
|
The "raw API" specs consists of JSON documents, on per
|
|
released version or branch, that describes the APIs. This is
|
|
suitable for creating documentation from, or may be useful for
|
|
language bindings as well.
|
|
|
|
The reference documentation is documentation fragments for each
|
|
API in each version, ready to be included in the libgit2 documentation
|
|
website.
|