Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects. The C/C++ projects are already supported as well, and it is planned to add special support for other languages as well.
Sample documentation with local source:
sphinx:
server:
enabled: true
doc:
board:
builder: 'html'
source:
engine: local
path: '/path/to/sphinx/documentation'
Sample documentation with Git source:
sphinx:
server:
enabled: true
doc:
board:
builder: 'html'
source:
engine: git
address: 'git@repo1.domain.com/repo.git'
revision: master
Sample documentation with Reclass source:
sphinx:
server:
enabled: true
doc:
board:
builder: 'html'
source:
engine: reclass
Sample documentation with pillar-schema source:
sphinx:
server:
enabled: true
doc:
schemas_doc:
author: Author
year: Year
version: Version
builder: 'html'
source:
engine: pillar-schema