Teknologian jakaminen

Joitakin vinkkejä Markdown Sphinxille Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docsia voidaan käyttää henkilökohtaisen kotisivun tai tietooppaan luomiseen. Internetissä on monia rakennusmenetelmiäartikla . Tässä artikkelissa puhutaan pääasiassa joistakin tekniikoista, jotka voivat tehdä projektista täydellisemmän.

Käyttöympäristöni on WSL2 Ubuntu 22.04 ja Sphinx-versio 7.3.7


Yhden projektin rakentaminen

Kun Sphinx on asennettu, suorita se terminaalissasphinx-quickstart, näyttöön tulee vaihtoehto: Onko sinun erotettava lähdehakemisto ja rakennushakemisto?
Lisää kuvan kuvaus tähän
Valitse kyllä ​​tästä, kirjoita y ja paina Enter. Erottelun etuna on, että projektirakenne on selkeämpi.

Täytä se rennosti. Viimeinen on projektin kieli, valitse yksinkertaistettu kiina.zh_CN
Lisää kuvan kuvaus tähän
Tässä vaiheessa projekti on valmis.


2. Asenna laajennus

1. Markdown-tukilaajennus – MyST-Parser

Sphinx tukee oletuksena ReStructuredTextiä, mutta useimmat ihmiset käyttävät Markdownia artikkeleiden kirjoittamiseen, joten sinun on asennettava laajennus MyST-Parser, joka tukee Markdownia. Sen virallinen verkkosivusto onhttps://myst-parser.readthedocs.io/en/latest/, asennuskomento on seuraava,

pip install -U myst-parser