Обмен технологиями

Несколько советов по Markdown Sphinx Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docs можно использовать для создания личной домашней страницы или учебного пособия. В Интернете существует множество методов создания. Вы можете обратиться к этому эксперту.статья . В этой статье в основном рассказывается о некоторых приемах, которые могут сделать проект более совершенным.

Моя рабочая среда — WSL2 Ubuntu 22.04, а версия Sphinx — 7.3.7.


Строительство одного проекта

После установки Sphinx запустите его в терминале.sphinx-quickstart, тогда появится опция: Нужно ли разделить каталог исходного кода и каталог сборки?
Вставьте сюда описание изображения
Выберите здесь «да», введите «y» и нажмите Enter. Преимущество разделения в том, что структура проекта становится более понятной.

Просто заполните его небрежно. Последний — язык проекта. Здесь выберите упрощенный китайский.zh_CN
Вставьте сюда описание изображения
На данный момент проект завершен.


2. Установите плагин

1. Плагин поддержки Markdown — MyST-Parser.

Sphinx по умолчанию поддерживает reStructuredText, но большинство людей используют Markdown для написания статей, поэтому вам необходимо установить плагин MyST-Parser, поддерживающий Markdown. Его официальный адрес сайта:https://myst-parser.readthedocs.io/en/latest/, команда установки следующая:

pip install -U myst-parser