sphinx构建html文档库

1、初识sphinx

        Sphinx 是一种文档工具，基于reStructuredText / rst格式编写文档, 有着众多的插件和良好的生态，可以生成高质量的出版级别的文档。

        目前，很多大公司，尤其是AI相关的大公司，都采用sphinx构建自己的文档系统。比如，寒武纪、nvidia、pytorch等等。

        具体效果可以查看以下寒武纪和NV的官网。

        寒武纪文档系统

        nvidia文档系统

2、sphinx环境构建

        sphinx的组件很多。功能也很强大，以下是我目前使用的一些基础的组件和主题。

#!/bin/bash

# 安装pip3
sudo dnf install python3-pip

# 安装markdown
sudo pip3 install markdown

# 安装sphinx相关工具
sudo pip3 install sphinx sphinx-autobuild sphinx_rtd_theme recommon