Seite 1 von 1

Doc WAPT

Veröffentlicht: 21. April 2017 - 10:39 Uhr
von OtOMatick
Hallo,
Ihre Dokumentation ist hervorragend! https://www.wapt.fr/fr/doc/
Könnten Sie mir bitte mitteilen, was ich benötige, um ein ähnliches Tool beim Kunden zu implementieren?
Ich nutze einen CentOS 7-Server und möchte meinem Kunden diese Art von Dokumentation zur Verfügung stellen.
Sie ist übersichtlich, einfach und sehr gut gemacht!

Vielen Dank für Ihr Feedback.

Betreff: WAPT-Dokument

Veröffentlicht: 21. April 2017 - 10:54 Uhr
von agauvrit
Hallo,

zunächst einmal vielen Dank im Namen von Tranquil IT Systems. Es freut uns immer sehr über Lob; unser gesamtes Team ist bestrebt, eine möglichst umfassende Dokumentation bereitzustellen.

Die Dokumentation selbst erstellen wir mit reStructuredText, Docutils und Sphinx.

Wenn Sie schon einmal Markdown oder ein Wiki bearbeitet haben, ist die Gliederung der Überschriften recht ähnlich. Der Hauptunterschied liegt im Kompilierungsprozess der Dokumentation, der es uns ermöglicht, Dokumentationen in verschiedenen Sprachen und Formaten (HTML, PDF, ePub und LaTeX) zu generieren.

Wenn Sie mehr über RST, Sphinx und Docutils erfahren möchten: https://www.jujens.eu/posts/2014/Aug/13 ... st-sphinx/

Die offizielle Dokumentation finden Sie hier: http://docutils.sourceforge.net/sandbox ... rt-fr.html

Alexandre

Betreff: WAPT-Dokument

Veröffentlicht: 21. April 2017 - 14:52 Uhr
von OtOMatick
Danke, ich habe das gewünschte Ergebnis erzielt. ;)
Jetzt werde ich mich damit beschäftigen, wie man das Gleiche manuell macht, da ` yum install` und `pip install` meinen Anforderungen nicht genügen.

Ich möchte die Kontrolle darüber behalten, was ich installiere, damit ich das installieren kann, was ich will, wo ich will (also ausgehend von den tar.gz-Dateien).

(Gibt es zufällig eine Dokumentation zur Installation des gesamten Quellcodes unter CentOS?)
((Noch besser! Ein fertiges, konfigurierbares Paket, das alles Notwendige ohne Abhängigkeiten enthält.))
(((Hey, bieten Sie so etwas nicht auch Ihren Kunden an? Verteilen Sie diese Art von Wiki über Wapt an die Rechner Ihrer Kunden für deren interne Informationen? Einige von ihnen haben wahrscheinlich Intranets oder Wikis.)))

Betreff: WAPT-Dokument

Veröffentlicht: 21. April 2017 - 17:15 Uhr
von agauvrit
Für eine Neuinstallation gibt es ehrlich gesagt nicht viel Dokumentation, abgesehen von der setup.py-Datei des Sphinx-Projekts: https://github.com/sphinx-doc/sphinx/bl ... r/setup.py.

Wir verwenden sie nicht unter Windows; der Dokumentations-Kompilierungs-Bot aus dem Git-Repository (Jenkins) verwendet pip-Befehle zur Installation der Abhängigkeiten.

Viel Erfolg trotzdem mit RST. ;)