reStructuredText（RST、ReST或reST）是一種用於文字資料的檔案格式，主要用於Python 程式語言社群的技術文件。 reStructuredText. reStructuredText logo. 副檔名 .rst.
Sphinx是一個功能強大的文件產生器，具有許多用於編寫技術文件的強大功能，包括：產生網頁，可列印的PDF，電子閱讀器的文檔（ePub），以及更多來自相同來源的文檔。可以使用reStructuredText或Markdown 編寫文檔。
使用pip安裝軟體包
- Sphinx：用於生成專案的技術文檔。
- sphinx_rtd_theme：一個專為 Read the Docs 設計的乾淨主題。
- myst_parser：允許在 Sphinx 中使用 Markdown 格式文檔的解析器。
pip install sphinx sphinx_rtd_theme myst_parser
mkdir wiki
cd wiki
sphinx-quickstart
make clean
make html
pip install myst_parser
Then in your conf.py:
extensions = ['myst_parser']
參考
- Sphinx操作教學介紹
- Markdown with Sphinx Quick Start
- Sphinx建立部落格
- Sphinx + MyST + Markdown for Static HTML Pages
reStructuredText（RST、ReST或reST）是一種用於文字資料的檔案格式，主要用於Python 程式語言社群的技術文件。 reStructuredText. reStructuredText logo. 副檔名 .rst.
Sphinx是一個功能強大的文件產生器，具有許多用於編寫技術文件的強大功能，包括：產生網頁，可列印的PDF，電子閱讀器的文檔（ePub），以及更多來自相同來源的文檔。可以使用reStructuredText或Markdown 編寫文檔。
使用pip安裝軟體包
pip install sphinx sphinx - autobuild sphinx_rtd_theme
mkdir wiki
cd wiki
sphinx-quickstart
make clean
make html
pip install myst_parser
Then in your conf.py:
extensions = ['myst_parser']
參考