在ubuntu使用sphinx编写html文档

Sphinx简介:

Sphinx [1]  是一个工具,它能够轻易地创建智慧和优雅的文档,出自Georg Brandl之手,在BSD许可证下授权。它能够把一组 reStructuredText 格式的文件转换成各种输出格式,而且自动地生成交叉引用,生成目录等。也就是说,如果有一个目录,里面包含一堆reST格式的文档(可能子目录里面也同样存在reST格式的文档),Sphinx能够生成一个漂亮的组织结构以及便于浏览和导航的HTML 文件(这些文件在其他的文件夹中)。当然对于同样的来源文件(reST格式),它也能够生成一个能够被编译(生成)PDF版本的LaTeX格式的文件 [2]  。

使用步骤:

1.安装aptitude,方便在ubuntu上查询适合安装的版本。

sudo apt-get install aptitude


2.查询下python可以安装的版本
aptitude search python3.5


3.开始安装python
sudo apt-get install python3.5


4.查询下pip可以安装的版本
aptitude search pip


5.开始安装python
sudo apt-get install python3-pip


6.修改系统bash:

添加:

lias python='python3.5'
alias pip='pip3'


export WORKON_HOME=$HOME/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3.5
export VIRTUALENVWRAPPER_VIRTUALENV=/home/tommy/.local/bin/virtualenv
source /home/tommy/.local/bin/virtualenvwrapper.sh
PATH=$PATH:/home/tommy/.local/bin/


各路径可以根据find、whereis命令查找:
find / -name virtualenvwrapper.sh
whereis python3.5


7.安装virtualenvwrapper
pip install virtualenvwrapper


8.具体操作vitualenvwrapper:
进入sphinx模式:
workon sphinx

        
sphinx基本操作:
http://zh-sphinx-doc.readthedocs.io/en/latest/rest.html


如何画图:
https://www.draw.io

参考:

https://baike.baidu.com/item/Sphinx/6120363

Virtualenv和Virtualenvwrapper的配置使用
https://blog.csdn.net/leafage_m/article/details/72854559

你可能感兴趣的:(Linux学习)