기술나눔

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을 클릭하면 옵션이 나타납니다: 소스 디렉터리와 빌드 디렉터리를 분리해야 합니까?
여기에 이미지 설명을 삽입하세요.
여기에서 yes를 선택하고 y를 입력한 후 Enter를 누르세요. 분리의 장점은 프로젝트 구조가 더 명확하다는 것입니다.

그냥 편하게 입력하세요. 마지막은 프로젝트 언어입니다. 여기서는 중국어 간체를 선택하세요.zh_CN
여기에 이미지 설명을 삽입하세요.
이 시점에서 프로젝트가 완료됩니다.


2. 플러그인 설치

1. 마크다운 지원 플러그인 - MyST-Parser

Sphinx는 기본적으로 reStructuredText를 지원하지만 대부분의 사람들이 Markdown을 사용하여 기사를 작성하므로 Markdown을 지원하는 플러그인 MyST-Parser를 설치해야 합니다. 공식 웹사이트 주소는 다음과 같습니다.최신, 설치 명령은 다음과 같습니다.

pip install -U myst-parser