Technology Sharing

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

Markdown Sphinx Read_the_Docs can be used to build personal homepages or knowledge tutorials. There are many ways to build them online. You can refer to this big guy'sarticle. This article mainly describes some techniques that can make the project more perfect.

My operating environment is WSL2 Ubuntu 22.04, and the Sphinx version is 7.3.7

---

One project construction

After Sphinx is installed, run in the terminalsphinx-quickstart, then an option will appear: Do you need to separate the source directory and the build directory?

Select yes here, enter y and press Enter. The benefit of separation is that the project structure is clearer.

Just fill in the following information. The last one is the project language. Select Simplified Chinese here.zh_CN

At this point, the project is complete.

---

2. Install the plugin

1. Markdown support plugin — MyST-Parser

Sphinx supports reStructuredText by default, but most people use Markdown to write articles, so here you need to install the Markdown-supported plug-in MyST-Parser, whose official website address ishttps://myst-parser.readthedocs.io/en/latest/, the installation command is as follows,

pip install -U myst-parser

                    上一篇
                    下一篇