Condivisione della tecnologia

Alcuni suggerimenti per Markdown Sphinx Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docs può essere utilizzato per creare una home page personale o un tutorial di conoscenza. Esistono molti metodi di creazione su Internet. Puoi fare riferimento a questo espertoarticolo . Questo articolo parla principalmente di alcune tecniche che possono rendere il progetto più perfetto.

Il mio ambiente di esecuzione è WSL2 Ubuntu 22.04 e la versione Sphinx è 7.3.7


Un progetto di costruzione

Dopo aver installato Sphinx, eseguilo nel terminalesphinx-quickstart, verrà visualizzata un'opzione: è necessario separare la directory di origine e la directory di compilazione?
Inserisci qui la descrizione dell'immagine
Seleziona sì qui, inserisci y e premi Invio. Il vantaggio della separazione è che la struttura del progetto è più chiara.

Compilalo casualmente. L'ultimo è la lingua del progetto. Qui, scegli Cinese semplificato.zh_CN
Inserisci qui la descrizione dell'immagine
A questo punto il progetto è completato.


2. Installare il plug-in

1. Plug-in di supporto Markdown: MyST-Parser

Sphinx supporta reStructuredText per impostazione predefinita, ma la maggior parte delle persone utilizza Markdown per scrivere articoli, quindi è necessario installare il plug-in MyST-Parser che supporta Markdown. L'indirizzo del sito Web ufficiale èhttps://myst-parser.readthedocs.io/it/latest/, il comando di installazione è il seguente,

pip install -U myst-parser