Documentation Formats ¶
-
Input formats
- JSON
- Markdown
-
reStructuredText Sphinx concepts and syntax
- reStructuredText Primer
- reStructuredText (RST, ReST, or reST) Cheatsheet
-
conf.py
Examples - sphinx code
- code-block (pygments, highlight)
- Comments
- Sphinx Directives
- sphinx domain
- Explicit Markup
- figure
- Sphinx Footnotes
- Sphinx Hyperlinks
- include
- Image
- sphinx markup
- Paragraphs
- Lists
- Sphinx raw html
- Source Code
- Source encoding
- sidebar
- Sphinx Sections
- Substitution
- toctree
- Tables
- Tutorials
- ReStructuredText tools
- Why reStructuredText and not markdown (2016)
- Tex / Latex
- Textile
- YAML
- Input/output formats
- Output formats