用sphinx将reStructuredText文档转化成其他格式

        用sphinx将reStructuredText开源书籍转化成其他格式

                                                               By qianghaohao

     今天在github看到了一个项目，是用reStructuredTex标记语言写的开源书籍，然后下载下来阅读，

结果发现下载下来的目录里面有很多各种格式的文件，并不能直接阅读，需要用sphinx编译成我们

可以阅读的格式，才可以看。比如html，pdf等格式。

   以下是用sphinx编译开源书籍项目:https://github.com/me115/linuxtools_rst产生html格式的全过程。

      一.sphinx工具简介:

           sphinx工具是一个由Grorg Brandl写的产生文档的工具，可以将reStructuredTex格式转化成

多种格式，如HTML,LaTex,ePub,Texinfo,manual pages,plain text等。

      二.使用sphinx编译开源书籍项目产生html格式的文档:

       1.先到 https://github.com/me115/linuxtools_rst下载开源书籍项目，然后解压到某个目录.

       2.安装Python:

             到 https://www.python.org/下载Python安装包安装，版本不要太老就行。

             安装完后配置好paht环境变量:

            

       3.安装pip工具(用来下载和安装第三方库的工具):

         下载 https://bootstrap.pypa.io/get-pip.py的内容保存成Python文件，比如get-pip.py(随便起个名字，只要是py后缀就行)。

         然后打开命令提示符用Python运行上面保存Python文件来安装pip:

             

         接下来配置pip工具的环境变量:

         

       4.用pip工具安装sphinx:

        

         

       5.进入工程目录查看makefile，然后开始编译:

       查看工程目录中的makefile:

     

    我们可以看到makefile中有多个目标，每个目标代表一种格式，可以编译成多种格式，在此我编译成了

    html格式的文档，所以下达如下命令开始编译:

     

    编译完成后会提示编译结果输出到了那个目录，在此输出到了_build目录:

   

   三.编译结果如下:

   进入到_build输出目录，可以看到我们编译产生的html文档，打开index.html结果如下：

   

  

   本文参考资料:

                  sphinx官方教程: http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx

             

转载于:https://www.cnblogs.com/codingnutter/p/5634480.html