技術共有

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

Markdown Sphinx Read_the_Docs は、個人のホームページやナレッジ チュートリアルを構築するために使用できます。インターネット上には、この専門家による構築方法が多数あります。記事 。この記事では主に、プロジェクトをより完璧にするためのいくつかのテクニックについて説明します。

私の実行環境はWSL2 Ubuntu 22.04、Sphinxのバージョンは7.3.7です。

---

ワンプロジェクト施工

Sphinx をインストールしたら、ターミナルで実行します。sphinx-quickstartをクリックすると、「ソース ディレクトリとビルド ディレクトリを分ける必要がありますか?」というオプションが表示されます。

ここでは「はい」を選択し、「y」を入力して Enter キーを押します。分離の利点は、プロジェクトの構造がより明確になることです。

最後にプロジェクトの言語を入力します。ここでは、簡体字中国語を選択します。日本語

この時点で、プロジェクトは完了です。

---

2. プラグインをインストールする

1. マークダウンサポートプラグイン - MyST-Parser

Sphinx はデフォルトで reStructuredText をサポートしていますが、ほとんどの人は Markdown を使用して記事を書くため、Markdown をサポートするプラグイン MyST-Parser をインストールする必要があります。その公式 Web サイトのアドレスは次のとおりです。https://myst-parser.readthedocs.io/en/latest/、インストールコマンドは次のとおりです。

pip install -U myst-parser

                    上一篇
                    下一篇