Home

Overview

Iden3's documentation engine provides an automatic procedure to retrieve the documentation (text + images) scattered in different repositories, build the html pages and present them into meaningful categories.

Requirements

• User building the documentation configures the list of source repositories where documentation is retrieved.
• Dev team can assign a document to be placed into a specific category in the doc web. If no category is assigned, document will be placed into a default category.
• Documents in default category are grouped by repository.
• Documentation engine accepts .rst, .md and .tex files as text files, and .png as image files
• Doc web is generated automatically when documentation files are modified.