sphinx构建内部文档Wiki系统

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了sphinx构建内部文档Wiki系统相关的知识,希望对你有一定的参考价值。

sphinx介绍:http://www.sphinx-doc.org/en/stable/


文档编辑流程:

#pandoc -s "F:\svn\Doc\extmail.docx" -t markdown -o F:\svn\Doc\extmail.
md
#pandoc F:\svn\Doc\extmail.md --from markdown --to rst -s -o F:\svn\Doc
\extmail.rst
1、编辑build文件夹内容
2、修改build/index.rst内容
3、运行make html即可

效果:

技术分享

技术分享


技术分享

index.rst源码:

.. ******Wiki documentation master file, created by
   sphinx-quickstart on Fri Mar  3 16:42:22 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ******Wiki‘s documentation!
============================================

.. toctree::
   :maxdepth: 3

   extmail
   rocketMQ安装
   SVN备份恢复日志管理
   ******发包流程文档

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


 

本文出自 “囧囧男” 博客,请务必保留此出处http://strongit.blog.51cto.com/10020534/1905073

以上是关于sphinx构建内部文档Wiki系统的主要内容,如果未能解决你的问题,请参考以下文章

Sphinx - 在代码块片段中使用省略号 (...)

使用sphinx快速生成Python API 文档

在使用Sphinx文档时,我应该告诉VCS忽略哪些文件? [关闭]

如何设置 Read the Docs 以便 Sphinx 自动文档选项起作用?

sphinx 编写文档使用记录

sphinx初识