Rest and Sphinx Memo
stable
Introduction
ReST
– reStructuredText
Sphinx
– Sphinx
Sphinx extensions
Sphinx project
References
Rest and Sphinx Memo
Docs
»
Sphinx/Rest Memo
Edit on GitHub
Sphinx/Rest Memo
¶
Contents:
Introduction
ReST
– reStructuredText
Structural elements
Emacs ReST mode
Sectioning
Transition
Inline markup
ReStructuredText Text Roles.
Lists
Bullet list
Horizontal lists
Enumerated list
Definition list
Field list
Options list
Blocks
Literal Block
Line blocks
Block quote
Pull-quote
Epigraph and highlights
Container
Class
Tables
Simple tables
Grid tables
csv table.
List Table.
LaTeX table rendering.
Cross reference.
Hypertext link.
Internal document reference.
Indirect Hyperlink.
Anonymous Hyperlink
Implicit Hyperlink Targets
Reference in citation style.
Embedded URI and Aliases
Standalone Hyperlink.
Difference between ReST and Sphinx location reference
Explicit Markup
Footnote
Citation
Rest Directives
table of contents
image and figure
Code blocks
Replacement
File include
Sidebar and Topic
Rubric
Comment
Common options
Sphinx
– Sphinx
Sphinx inline markup
Location cross references
Automatic labels for sections
Cross-referencing documents.
Extra cross-reference roles
Extensions that define new hyperlinks targets
Sphinx Roles.
Python Roles.
Sphinx directives
Table of contents.
Index.
Glossary.
Note, Warning, Seealso.
Selective inclusion.
Defining a css class for some part.
Using your new style
Sphinx Source Code.
Code highlighting.
Source code include.
Source code directives.
autodoc
Using info field lists in Docstrings.
Docstring alternate syntax.
Google style docstrings.
Sphinx extensions
todo extension
Sphinx Math
Multiline Math
Equation Numbers
Graphs with Graphviz
Examples
Sphinx project
References
Sphinx and Rest References
How to write docstrings
Extending Sphinx
Indices and tables
¶
Index
Module Index
Search Page
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.