Sphinix 說明文件

• Introduction
• Install Sphinx
  • Overview
  • Linux
  • MacOS
  • Windows
  • Installation from PyPI
• Quick Start
  • Start a new project document
  • Generate Output
  • Switch Theme
  • AutoDoc
  • Run in Docker image
• Connect & Deploy to ReadTheDoc websit
  • Export to ReadDoc website through GitHub
• reST language
  • Headers
  • Link & Reference
  • List & quoted-like block
  • 未分類
  • Paragraphs & Markup
  • Roles
  • Table
• Directives
  • Table and Paragraph markup
  • toctree
• Extensions
  • sphinx.ext.autodoc - Include documentation from docstrings
  • sphinx.ext.napoleon - Support for Numpy and Google style docstrings
  • sphinx.ext.viewcode - Add links to hightlighted source code
• Example code for autodoc
  • Example code for google-style
  • Example code for numpy

Indices and tables

• Index
• Module Index
• Search Page