mirror of https://github.com/libgit2/libgit2.git synced 2026-01-25 02:56:17 +00:00

Files

Edward Thomson 89cc5ef8e8 Include documentation generator

libgit2 has a new documentation generator that generates API schema from
our headers, then produces reference documentation that is included into
the website directly.

2024-11-25 23:00:07 +00:00

api-generator.js

Include documentation generator

2024-11-25 23:00:07 +00:00

docs-generator.js

Include documentation generator

2024-11-25 23:00:07 +00:00

generate

Include documentation generator

2024-11-25 23:00:07 +00:00

package-lock.json

Include documentation generator

2024-11-25 23:00:07 +00:00

package.json

Include documentation generator

2024-11-25 23:00:07 +00:00

README.md

Include documentation generator

2024-11-25 23:00:07 +00:00

README.md

API Documentation Generator

These scripts generate the "raw API" specs and reference documentation for www.libgit2.org.

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.