Dokumentation zu github



  • Kann ich javadoc/doxygen style Dokumentation irgendwie in ein Format bekommen, dass ich in die github wiki übertragen kann? (markdown?)

    Oder wie wäre die beste Vorgehensweise, abgesehen von einer externen Webseite?
    - Vielleicht automatische Dokumentationsgeneration mit cmake?
    - Dokumentation direkt im git?

    EDIT: Soll zusätzlich zur Einleitung, Tutorial, usw sein. Nicht ersetzen.



  • Ich habe https://github.com/pferdinand/doxygen2md entdeckt und geforked.
    Damit kann ich die Doxygen Dokumentation in relativ sauberes markdown umwandeln (nach tweaks und template Anpassung) und direkt in das wiki.git einpflegen.


Anmelden zum Antworten