Compartilhamento de tecnologia

Algumas dicas para Markdown Sphinx Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docs pode ser usado para construir uma página inicial pessoal ou tutorial de conhecimento. Existem muitos métodos de construção na Internet.artigo . Este artigo fala principalmente sobre algumas técnicas que podem tornar o projeto mais perfeito.

Meu ambiente de execução é WSL2 Ubuntu 22.04 e a versão Sphinx é 7.3.7


Construção de um projeto

Depois que o Sphinx estiver instalado, execute-o no terminalsphinx-quickstart, então aparecerá uma opção: Você precisa separar o diretório de origem e o diretório de construção?
Insira a descrição da imagem aqui
Selecione sim aqui, insira y e pressione Enter. A vantagem da separação é que a estrutura do projeto é mais clara.

Basta preencher casualmente. O último é o idioma do projeto. Aqui, escolha Chinês Simplificado.zh_CN
Insira a descrição da imagem aqui
Neste ponto, o projeto está concluído.


2. Instale o plug-in

1. Plug-in de suporte Markdown – MyST-Parser

Sphinx suporta reStructuredText por padrão, mas a maioria das pessoas usa Markdown para escrever artigos, então você precisa instalar o plug-in MyST-Parser que suporta Markdown. O endereço do site oficial é.https://myst-parser.readthedocs.io/en/latest/, o comando de instalação é o seguinte,

pip install -U myst-parser