Partage de technologie

Quelques conseils pour Markdown Sphinx Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docs peut être utilisé pour créer une page d'accueil personnelle ou un didacticiel de connaissances. Il existe de nombreuses méthodes de création sur Internet. Vous pouvez vous référer à cet expert.article . Cet article parle principalement de certaines techniques qui peuvent rendre le projet plus parfait.

Mon environnement d'exécution est WSL2 Ubuntu 22.04 et la version Sphinx est 7.3.7


Un projet de construction

Une fois Sphinx installé, exécutez-le dans le terminalsphinx-quickstart, alors une option apparaîtra : Avez-vous besoin de séparer le répertoire source et le répertoire de build ?
Insérer la description de l'image ici
Sélectionnez oui ici, entrez y et appuyez sur Entrée. L’avantage de la séparation est que la structure du projet est plus claire.

Remplissez-le simplement avec désinvolture. Le dernier est la langue du projet. Ici, choisissez le chinois simplifié.zh_CN
Insérer la description de l'image ici
À ce stade, le projet est terminé.


2. Installez le plug-in

1. Plug-in de prise en charge de Markdown : MyST-Parser

Sphinx prend en charge reStructuredText par défaut, mais la plupart des gens utilisent Markdown pour rédiger des articles, vous devez donc installer le plug-in MyST-Parser qui prend en charge Markdown. Son adresse de site Web officielle est.https://myst-parser.readthedocs.io/fr/dernieres/, la commande d'installation est la suivante,

pip install -U myst-parser