[JIRA] (OVIRT-1217) Switch infra-docs to use mkdocs for building

[Barak Korren (oVirt JIRA)]

Barak Korren created OVIRT-1217:
-----------------------------------

             Summary: Switch infra-docs to use mkdocs for building
                 Key: OVIRT-1217
                 URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1217
             Project: oVirt - virtualization made easy
          Issue Type: Improvement
          Components: wiki (MediaWiki)
            Reporter: Barak Korren
            Assignee: infra


The infra docs are currently built using Sphinx (The Python doc generator, that natively works with RST) with a markdown adapter.

*mkdocs* is a markdown-native tool. It offers several advantages over Sphinx:

* It is far simpler to use the Sphinx or pandocs
* It supports extended markdown syntax that is better aligned with what GitHub and others supports
* The output looks exactly like it would look on readthedocs
* It is easy to generate documentation menus and links with it
* There is a very useful "local server" mode




--
This message was sent by Atlassian JIRA
(v1000.789.5#100032)