Sphinx ist ein nützliches Python-basiertes Tool für Techniker und Autoren, mit dem sie auf einfache Weise elegante, voll funktionsfähige Dokumentationen in verschiedenen Formaten erstellen können. Mit Sphinx schreiben Sie Dokumente zunächst mit reStructuredText - einer einfachen Markup-Sprache - und können dann die Ausgabe in verschiedenen Formaten abrufen, darunter HTML, LaTeX, PDF, ePub und andere.
In diesem Tutorial werden wir den Prozess der Installation und Verwendung Sphinxauf einer CentOS 7 x64-Instanz auf der Vult-Plattform behandeln.
sudo yum update
sudo shutdown -r now
sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx
Bevor Sie mit der Verwendung beginnen Sphinx, müssen Sie Ihr Quellverzeichnis angeben, in dem Sphinxdie gesamte Dokumentation ausgeführt und gespeichert werden soll. Nachdem Sie das Verzeichnis erstellt haben, das Sie verwenden möchten, können Sie es ausführen sphinx-quickstart, Sphinxum die erforderliche Grundkonfiguration zu initialisieren und zu erstellen.
sphinx-quickstart ähnelt einem Setup-Assistenten, der Sie mit Fragen auffordert, die die Aspekte Ihres Projekts bestimmen.
cd ~
mkdir doc1
cd doc1
sphinx-quickstart
Standardmäßig erstellt der sphinx-quickstartAssistent mehrere Verzeichnisse und Dateien.
_build # The directory for containing Sphinx output
conf.py # The file containing your project configurations
index.rst # The master file containing the hierarchy of your documentation
make.bat # A Windows command file
Makefile # A file necessary for running the make command
_static # The directory for static files, including custom stylesheets, pictures, etc.
_templates # The directory for custom templates
Werfen wir einen Blick auf die Masterdatei index.rst, die die Hierarchie Ihrer Dokumentation enthält. nämlich das Inhaltsverzeichnis Baum oder toctree.
Öffnen Sie es mit einem Texteditor:
vi index.rst
Wenn Sie die Datei überprüfen, werden Sie einen Abschnitt mit dem Namen bemerken toctree. Wenn Sie andere Quelldateien ( *.rst) für Ihre Dokumentation haben, müssen Sie diese im toctreeAbschnitt angeben : .. toctree ::: maxdepth: 2
introduction
chapter1
chapter2
chapter3
more
Es ist unbedingt erforderlich:
.rst.:maxdepth: 2.Wenn Sie Ihre Änderungen abgeschlossen haben, speichern Sie Ihre Datei und beenden Sie den Texteditor.
ESC
:!wq
Die Quelldateien müssen mit Namen erstellt werden, die mit den zuvor angegebenen übereinstimmen. index.rstAndernfalls werden sie nicht in die endgültige Ausgabe aufgenommen.
Alle Quelldateien müssen mit dem kompatibel sein reStructuredText markup language. Weitere Informationen finden Sie unter reStructuredText Primer .
Nachdem Sie Ihre Dokumentation erstellt haben, können Sie Ihre Arbeit ausgeben, HTML format indem Sie den folgenden Befehl ausführen:
make html
Die Ausgabe wird in dem Verzeichnis gespeichert, ./\_build/htmldas alles enthält, was zum Anzeigen der Datei in einem Webbrowser erforderlich ist.
Damit ist unser Tutorial abgeschlossen.
Verwenden Sie ein anderes System? MODX Revolution ist ein schnelles, flexibles, skalierbares, kostenloses und Open-Source-Content-Management-System (CMS) für Unternehmen, das i
Vultr bietet Ihnen eine hervorragende Konnektivität für private Netzwerke für Server, die am selben Standort ausgeführt werden. Aber manchmal möchten Sie zwei Server in verschiedenen Ländern
Verwenden Sie ein anderes System? Einführung CyberPanel ist eines der ersten Control Panels auf dem Markt, das sowohl Open Source als auch OpenLiteSpeed verwendet. Was ist das?
Verwenden Sie ein anderes System? ESpeak kann TTS-Audiodateien (Text-to-Speech) generieren. Diese können aus vielen Gründen nützlich sein, z. B. um Ihr eigenes Turin zu erstellen
Verwenden Sie ein anderes System? Thelia ist ein Open-Source-Tool zum Erstellen von E-Business-Websites und zum Verwalten von Online-Inhalten, die in PHP geschrieben wurden. Thelia Quellcode i
Cockpit ist ein kostenloses Open Source-Programm für die Linux-Serververwaltung. Es ist sehr leicht und hat eine schöne, einfach zu bedienende Weboberfläche. Es erlaubt System
Gollum ist die Git-basierte Wiki-Software, die als Backend des GitHub-Wikis verwendet wird. Durch die Bereitstellung von Gollum können Sie ein GitHub-ähnliches Wiki-System auf Ihnen hosten
BBR (Bottleneck Bandwidth and RTT) ist ein neuer Algorithmus zur Überlastungskontrolle, der von Google zum Linux-Kernel-TCP-Stack hinzugefügt wird. Mit BBR an Ort und Stelle,
YOURLS (Your Own URL Shortener) ist eine Open-Source-Anwendung zur URL-Verkürzung und Datenanalyse. In diesem Artikel werden wir den Installationsprozess behandeln
Verwenden Sie ein anderes System? RTMP eignet sich hervorragend für die Bereitstellung von Live-Inhalten. Wenn RTMP mit FFmpeg gekoppelt ist, können Streams in verschiedene Qualitäten konvertiert werden. Vultr i
LimeSurvey ist ein kostenloses und Open-Source-Online-Umfragetool, das häufig zum Veröffentlichen von Online-Umfragen und zum Sammeln von Umfrage-Feedback verwendet wird. In diesem Artikel werde ich
Einführung Java ist eine beliebte Softwareplattform, mit der Sie Java-Anwendungen und -Applets in verschiedenen Hardwareumgebungen entwickeln und ausführen können. Es gibt
Verwenden Sie ein anderes System? Netdata ist ein aufstrebender Stern im Bereich der Echtzeitüberwachung von Systemmetriken. Im Vergleich zu anderen Tools der gleichen Art bietet Netdata:
In diesem Tutorial erfahren Sie, wie Sie einen Just Cause 2-Multiplayer-Server einrichten. Voraussetzungen Bitte stellen Sie sicher, dass das System vollständig aktualisiert ist, bevor Sie beginnen
Verwenden Sie ein anderes System? In diesem Tutorial werde ich erklären, wie ein Starbound-Server unter CentOS 7 eingerichtet wird. Voraussetzungen Sie müssen dieses Spiel besitzen
ZNC ist ein kostenloser Open-Source-IRC-Bouncer, der permanent mit einem Netzwerk verbunden bleibt, sodass Clients Nachrichten empfangen können, die gesendet werden, während sie offline sind. Thi
Django ist ein beliebtes Python-Framework zum Schreiben von Webanwendungen. Mit Django können Sie Anwendungen schneller erstellen, ohne das Rad neu zu erfinden. Wenn du willst
ionCube Loader ist eine PHP-Erweiterung, mit der ein Webserver PHP-Dateien ausführen kann, die mit ionCube Encoder codiert wurden und für deren Ausführung erforderlich sind
Einführung Installieren Sie in diesem Tutorial PufferPanel auf unserem Vultr VPS. PufferPanel ist ein Open Source-Bedienfeld, das Sie kostenlos verwalten können
Verwenden Sie ein anderes System? Einführung BoltWire ist ein kostenloses und leichtes Content-Management-System, das in PHP geschrieben wurde. Im Vergleich zu den meisten anderen Content Managern
Ransomware-Angriffe nehmen zu, aber kann KI helfen, den neuesten Computervirus zu bekämpfen? Ist KI die Antwort? Lesen Sie hier, ob KI boone oder bane ist
ReactOS, ein quelloffenes und kostenloses Betriebssystem, ist hier mit der neuesten Version. Kann es den Anforderungen moderner Windows-Benutzer genügen und Microsoft zu Fall bringen? Lassen Sie uns mehr über dieses alte, aber neuere Betriebssystem erfahren.
Whatsapp hat endlich die Desktop-App für Mac- und Windows-Benutzer auf den Markt gebracht. Jetzt können Sie ganz einfach von Windows oder Mac auf WhatsApp zugreifen. Verfügbar für Windows 8+ und Mac OS 10.9+
Lesen Sie dies, um zu erfahren, wie Künstliche Intelligenz bei kleinen Unternehmen beliebt wird und wie sie die Wahrscheinlichkeit erhöht, sie wachsen zu lassen und ihren Konkurrenten einen Vorsprung zu verschaffen.
Vor kurzem hat Apple macOS Catalina 10.15.4 als Ergänzungsupdate veröffentlicht, um Probleme zu beheben, aber es scheint, dass das Update mehr Probleme verursacht, die zum Bricking von Mac-Computern führen. Lesen Sie diesen Artikel, um mehr zu erfahren
13 Tools zur kommerziellen Datenextraktion von Big Data
Unser Computer speichert alle Daten in einer organisierten Weise, die als Journaling-Dateisystem bekannt ist. Es ist eine effiziente Methode, die es dem Computer ermöglicht, Dateien zu suchen und anzuzeigen, sobald Sie auf die Suche klicken.https://wethegeek.com/?p=94116&preview=true
Da sich die Wissenschaft schnell weiterentwickelt und einen Großteil unserer Bemühungen übernimmt, steigt auch das Risiko, uns einer unerklärlichen Singularität auszusetzen. Lesen Sie, was Singularität für uns bedeuten könnte.
Ein Einblick in 26 Big-Data-Analysetechniken: Teil 1
KI im Gesundheitswesen hat in den letzten Jahrzehnten große Fortschritte gemacht. Somit wächst die Zukunft der KI im Gesundheitswesen immer noch von Tag zu Tag.
