Technologieaustausch

Einige Tipps für Markdown Sphinx Read_the_Docs

2024-07-11

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Markdown Sphinx Read_the_Docs kann zum Erstellen einer persönlichen Homepage oder eines Wissens-Tutorials verwendet werden. Es gibt viele Erstellungsmethoden im Internet. Sie können auf die Anleitung dieses Experten zurückgreifenArtikel . In diesem Artikel geht es hauptsächlich um einige Techniken, die das Projekt perfekter machen können.

Meine Laufumgebung ist WSL2 Ubuntu 22.04 und die Sphinx-Version ist 7.3.7


Ein Projektbau

Nachdem Sphinx installiert ist, führen Sie es im Terminal aussphinx-quickstart, dann erscheint eine Option: Müssen Sie das Quellverzeichnis und das Build-Verzeichnis trennen?
Fügen Sie hier eine Bildbeschreibung ein
Wählen Sie hier „Ja“, geben Sie „y“ ein und drücken Sie die Eingabetaste. Der Vorteil der Trennung besteht darin, dass die Projektstruktur klarer ist.

Füllen Sie es einfach beiläufig aus. Das letzte ist die Projektsprache. Wählen Sie hier Vereinfachtes Chinesisch.zh_CN
Fügen Sie hier eine Bildbeschreibung ein
Zu diesem Zeitpunkt ist das Projekt abgeschlossen.


2. Installieren Sie das Plug-in

1. Markdown-Unterstützungs-Plug-in – MyST-Parser

Sphinx unterstützt standardmäßig reStructuredText, aber die meisten Leute verwenden Markdown zum Schreiben von Artikeln, daher müssen Sie das Plug-in MyST-Parser installieren, das Markdown unterstützt. Die offizielle Website-Adresse lautethttps://myst-parser.readthedocs.io/en/latest/Der Installationsbefehl lautet wie folgt:

pip install -U myst-parser