Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx!

• Sphinx 使用手册

---

reStructuredText

• http://docutils.sourceforge.net/rst.html

Install & Build

requirements.txt

sphinx
sphinx-rtd-theme
sphinx-markdown-tables
recommonmark

• install

  Bash

  pip install -r docs/requirements.txt
  

• build

  Bash

  cd docs
  make html