Ich habe die Dokumentation für eine mittelgroße C ++ - Software unter Verwendung von Doxygen zusammen mit Markdown geschrieben. Ich bin ziemlich glücklich damit, nachdem ich die XML-Ebene gewechselt habe, habe ich so etwas gefunden: Ссылка
Ich möchte diese Dokumentation online bringen, idealerweise mit etwas wie ReadtheDocs, wo die Dokumentation nach einem "git commit" automatisch erstellt und zum Durchsuchen gehostet wird.
ReadtheDocs sieht wie die ideale Site aus, verwendet jedoch Sphinx und reStructuredText als Standardwerte. Doxygen kann auch verwendet werden, aber AFAIK nur durch Atmen. Wenn ich diese Route durchführe, bedeutet das im Wesentlichen, dass ich die gesamte Dokumentation neu strukturieren muss, wenn ich nicht die gesamte API-Dokumentation auf einer einzigen Seite ablegen möchte ( Ссылка ).
Paradoxerweise ist Doxygen auf dem Read-the-Docs-Server installiert, aber nach dem Problem konnte ich keine Abhilfe finden, um seine Sphinx oder Mkdocs zu überspringen.
Ich habe die folgende Lösung ausprobiert, um Doxygen bei Read The Docs zu verwenden und es scheint zu funktionieren:
Ich habe das mit folgendem Quellbaum getestet:
%Vor%Einige Erklärung:
Was zu tun ist:
füge folgende Zeilen in conf.py hinzu, um doxygen docs zu generieren:
%Vor%Aktualisieren Sie die conf.py html_extra_path -Direktive auf:
%Vor%In dieser Konfiguration sollte ReadTheDocs die Doxygen-HTML-Dokumentation korrekt generieren und speichern.
todo:
Tags und Links doxygen read-the-docs