King of the Sphinx documentation tool

Sphinx

https://www.sphinx.org.cn/

Sphinx is a tool, you can easily create written by Georg Brandl and licensed under the BSD license intelligent and beautiful documentation

It was originally developed for Python documentation is created, it has excellent tools for software project documentation in various languages. Of course, this site is created using source reStructuredText

  • Output formats: HTML (including Windows HTML Help), LaTeX (suitable for printable PDF version), ePub, Texinfo, man pages, plain text
  • CROSS REFERENCE wide: semantic tags and functions, classes, references, automatic links glossary terms and similar information
  • Hierarchy: easy to define document tree, automatically linked to the same level, superior and subordinate
  • Auto Index: General Index as well as language-specific module index
  • Processing Code: Use Pygments Highlighter automatically highlighted
  • Extensions: document snippet automatic test string, comprising Python modules (API documentation) of the like
  • Extended contributions: the user in a second repository contribution a plurality of extensions 50; most be installed from PyPI

 

getting Started

https://www.sphinx.org.cn/usage/quickstart.html

 

example

https://github.com/plasmatech8/Python-Sphinx-Demo

 

Guess you like

Origin www.cnblogs.com/lightsong/p/11854130.html