快速鏈接:
.
👉👉👉 個人博客筆記導(dǎo)讀目錄(全部) 👈👈👈

文章目錄

• • • • 背景
      • 環(huán)境搭建-安裝Sphinx工具
      • 創(chuàng)建一個項(xiàng)目
      • 編譯項(xiàng)目

關(guān)鍵詞:Sphinx, readthedocs, reStructuredText

背景

在當(dāng)下一些主流的開源社區(qū)、公司公開或非公開的項(xiàng)目，都采用了Sphinx+readthedocs方案。這種編寫文檔的方式，每一個開發(fā)者都可以參與，都可以提交自己的文檔…
寫文檔就像寫代碼一樣，可以多人協(xié)助

環(huán)境搭建-安裝Sphinx工具

環(huán)境要求: ubuntu, 已安裝過python3,make,git等工具, 如果沒有安裝過，可以使用下列命令進(jìn)行安裝：

sudo apt install git
sudo apt install make
sudo apt install python3
sudo apt install python3-pip

接下來就是安裝Sphinx及其依賴了：

pip3 install -U Sphinx
pip3 install sphinx-autobuild
pip3 install sphinx_rtd_theme
pip3 install recommonmark
pip3 install sphinx_markdown_tables

安裝換成此后

test@test-21:~/workspace$ sphinx- sphinx-apidoc sphinx-autobuild sphinx-autogen sphinx-build sphinx-quickstart

創(chuàng)建一個項(xiàng)目

使用sphinx-quickstart命令可快速創(chuàng)建一個項(xiàng)目

項(xiàng)目創(chuàng)建后，自動生成如下文件：

編譯項(xiàng)目

敲擊make html即可完成編譯

編譯后，用瀏覽器打開build/html/index.html，即可看到漂亮的界面了：

補(bǔ)充知識：

• make html // 編譯，輸出html
• make singlehtml //編譯，生成單個html
• make latexpdf //編譯，生成pdf文件

總結(jié)

以上是生活随笔為你收集整理的[How TO]-如何使用Sphinx编写漂亮的文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。