Li-Pro.Net Sphinx Primer
0.0.4
Table of Contents
1. Concepts
1.1. Use of whitespace
1.1.1. Indentation
1.2. Sphinx naming
1.2.1. Roles
1.2.2. Directives
1.2.3. Domains
1.3. Parts, Chapters, Titles, Sections
1.4. Table of Contents Tree
1.4.1. Sidebar navigation menu
1.4.2. Secondary sub-TOC trees
1.4.3. How this document uses main and secondary TOC
1.5. Paragraphs
1.5.1. Quotes (block quotation) Element
1.5.2. Line Blocks
1.5.3. Doctest Blocks
1.6. Inline Markup
1.7. File, Directory, Path
1.8. Lists, Definition Lists
1.8.1. Unordered (bullet) Lists
1.8.2. Ordered (numbered) Lists
1.8.3. Definition (description) Lists
Field (description) Lists
1.9. Explicit Markup
1.9.1. Comments
1.9.2. Directives
1.9.3. Footnotes
1.9.4. Citations
1.10. Reuse Content
1.10.1. Include a Shared File
1.10.2. Substitutions
Styled Reference
Use Prolog and Epilog
Inline Image
1.11. Images and Figures
1.11.1. SVG Graphics only
1.11.2. PNG Images only
1.11.3. Inserting
1.11.4. Inserting with Captions
1.11.5. Inserting Inline
1.12. Tables
1.12.1. Grid Style
1.12.2. Simple Style
1.12.3. List Table
1.12.4. CSV Table
1.13. Code Example
1.13.1. Explicit Code Blocks
1.13.2. Explicit Code Includes
1.14. Mathematics
1.15. Admonitions
1.15.1. Generic Admonition
1.15.2. Specific Admonitions
Attention Admonition
Caution Admonition
Danger Admonition
Error Admonition
Hint Admonition
Important Admonition
Note Admonition
Tip Admonition
Warning Admonition
1.15.3. Sphinx Additional Admonitions
Seealso Admonition
1.16. Hyperlink
1.17. Referencing
1.17.1. A cool section
1.18. External References
1.19. Downloadable Files
1.20. Semantic Descriptions and References
1.21. Writing about User Interface
1.21.1. Other Semantic Markup
1.22. Glossary
1.22.1. Create a Glossary
1.22.2. Link a Term to its Glossary Entry
1.23. Index
2. Extensions
2.1. Spelling Checker
2.1.1. Private Dictionaries
2.2. BibTeX Citations
2.3. LinuxDoc
2.3.1. Flat list table
2.4. Program Output
2.4.1. Complete output
2.4.2. Shortening the output
2.4.3. Mimicking shell input
2.4.4. Command execution and shell expansion
2.4.5. Error handling
2.5. Mathematical Plots
2.5.1. Expressions
2.5.2. Plots
3D-Plots
2.6. PGF/TikZ LaTeX Pictures
2.7. Block Diagram Family
2.7.1. Block Diagram
Directive Body Diagram
Description Table
Include Diagram
2.7.2. Sequence Diagram
Directive Body Diagram
Description Table
Include Diagram
2.7.3. Activity Diagram
Directive Body Diagram
Description Table
Include Diagram
2.7.4. Network Diagram
Directive Body Diagram
Description Table
Include Diagram
2.8. Tabbed Content
2.9. Paneled Content
2.10. Email Obfuscate
3. Themes
3.1. Read the Docs Sphinx Theme
4. Cheat Sheet
Appendices
Appendix
License
Credits
Glossary
Terms
Lists and References
Listings
List of Tables
List of Figures
List of Equations
List of Downloads
List of Issues (To-Do)
Bibliography
Index
Li-Pro.Net Sphinx Primer
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
X
Symbols
--force
dlapp command line option
--ignore <regex>
dlapp command line option
-f
dlapp command line option
-i <regex>
dlapp command line option
A
:align: (directive option)
csv-table (directive)
abbr (role)
actdiag (directive)
Activity Diagram
Sphinx Extension
Additional
Sphinx Admonitions
admonition (directive)
Admonitions
Additional, Sphinx
Attention, Sphinx
Caution, Sphinx
Danger, Sphinx
Error, Sphinx
Generic, Sphinx
Hint, Sphinx
Important, Sphinx
Note, Sphinx
Seealso, Sphinx
Specific, Sphinx
Sphinx Syntax
Tip, Sphinx
Warning, Sphinx
Appendix
Li-Pro.Net Sphinx Primer
Attention
Sphinx Admonitions
attention (directive)
B
badge (role)
Bibliography
Li-Pro.Net Sphinx Primer
BibTeX
BibTeX Citations
Sphinx Extension
Block Diagram
Sphinx Extension
Block Diagram Family
Sphinx Extension
Block Quotation
Sphinx Syntax
blockdiag (directive)
C
C
C++
Caution
Sphinx Admonitions
caution (directive)
Cheat Sheet
Li-Pro.Net Sphinx Primer
Citations
Sphinx Syntax
code (role)
Code Blocks
Sphinx Syntax
Code Example
Sphinx Syntax
code-block (directive)
command (role)
command-output (directive)
Comments
Sphinx Syntax
Concepts
Li-Pro.Net Sphinx Primer
configuration value
spelling_word_list_filename
Credits
Li-Pro.Net Sphinx Primer
cspan (role)
CSS
CSV Table
Sphinx Syntax
csv-table (directive)
:align: (directive option)
:delim: (directive option)
:file: (directive option)
:header: (directive option)
:url: (directive option)
:widths: (directive option)
D
:delim: (directive option)
csv-table (directive)
Danger
Sphinx Admonitions
danger (directive)
Definition Lists
Sphinx Syntax
dfn (role)
Directives
Sphinx Syntax
,
[1]
div (directive)
dlapp command line option
--force
--ignore <regex>
-f
-i <regex>
DLAPPRC
doc (role)
Doctest Blocks
Sphinx Syntax
Docutils
Domains
Sphinx Syntax
download (role)
Downloadable Files
Sphinx Syntax
Downloads
Li-Pro.Net Sphinx Primer
dropdown (directive)
E
ECMAScript
email (role)
Email Obfuscate
Sphinx Extension
emphasis (role)
Enchant
environment variable
DLAPPRC
,
[1]
envvar (directive)
(role)
eq (role)
Equations
Li-Pro.Net Sphinx Primer
Error
Sphinx Admonitions
error (directive)
ES
Explicit Markup
Sphinx Syntax
Extension
Activity Diagram, Sphinx
BibTeX Citations, Sphinx
Block Diagram Family, Sphinx
Block Diagram, Sphinx
Email Obfuscate, Sphinx
LinuxDoc, Sphinx
Mathematical Plots, Sphinx
Network Diagram, Sphinx
Paneled Content, Sphinx
PGF/TikZ LaTeX Pictures, Sphinx
Program Output, Sphinx
Sequence Diagram, Sphinx
Spelling Checker, Sphinx
Tabbed Content, Sphinx
Extensions
Li-Pro.Net Sphinx Primer
External Referencing
Sphinx Syntax
F
:file: (directive option)
csv-table (directive)
:fill-cells: (directive option)
flat-table (directive)
fa (role)
Field Lists
Sphinx Syntax
figure (directive)
Figures
Li-Pro.Net Sphinx Primer
Sphinx Syntax
file (role)
Files
Sphinx Syntax
flat-table (directive)
:fill-cells: (directive option)
:header-rows: (directive option)
:stub-columns: (directive option)
:widths: (directive option)
Footnotes
Sphinx Syntax
G
Generic
Sphinx Admonitions
Glossary
Li-Pro.Net Sphinx Primer
Sphinx Syntax
glossary (directive)
Grid Table
Sphinx Syntax
group-tab (directive)
guilabel (role)
H
:header-rows: (directive option)
flat-table (directive)
:header: (directive option)
csv-table (directive)
Header
Sphinx Syntax
highlight (directive)
Hint
Sphinx Admonitions
hint (directive)
HTML
Hyperlink
Sphinx Syntax
I
image (directive)
Images
Sphinx Syntax
Important
Sphinx Admonitions
important (directive)
include (directive)
Includes
Sphinx Syntax
Index
Sphinx Syntax
index (directive)
(role)
Inline Image
Sphinx Syntax
Inline Markup
Sphinx Syntax
Issues
Li-Pro.Net Sphinx Primer
J
JavaScript
JS
K
kbd (role)
L
LaTeX
Li-Pro.Net Sphinx Primer
Appendix
Bibliography
Cheat Sheet
Concepts
Credits
Downloads
Equations
Extensions
Figures
Glossary
Issues
License
List of Downloads
List of Equations
List of Figures
List of Issues
List of Listings
List of Tables
Listings
Tables
Themes
License
Li-Pro.Net Sphinx Primer
Line Blocks
Sphinx Syntax
link-badge (role)
link-button (directive)
LinuxDoc
Sphinx Extension
List of Downloads
Li-Pro.Net Sphinx Primer
List of Equations
Li-Pro.Net Sphinx Primer
List of Figures
Li-Pro.Net Sphinx Primer
List of Issues
Li-Pro.Net Sphinx Primer
List of Listings
Li-Pro.Net Sphinx Primer
List of Tables
Li-Pro.Net Sphinx Primer
List Table
Sphinx Syntax
list-table (directive)
Listings
Li-Pro.Net Sphinx Primer
Lists, Definition Lists
Sphinx Syntax
literal (role)
Literalinclude
Sphinx Syntax
literalinclude (directive)
M
math (directive)
(role)
math:numref (role)
Mathematical Plots
Sphinx Extension
Mathematics
Sphinx Syntax
mathmpl (directive)
menuselection (role)
N
Naming
Sphinx Syntax
Network Diagram
Sphinx Extension
Note
Sphinx Admonitions
note (directive)
numref (role)
nwdiag (directive)
O
opticon (role)
option (directive)
(role)
Ordered Lists
Sphinx Syntax
Other Semantic Markup
Sphinx Syntax
P
packet (directive)
Paneled Content
Sphinx Extension
panels (directive)
Paragraphs
Sphinx Syntax
PDF
pep (role)
pep-reference (role)
PGF
PGF/TikZ
PGF/TikZ LaTeX Pictures
Sphinx Extension
plot (directive)
PNG
program (directive)
(role)
Program Output
Sphinx Extension
program-output (directive)
pull-quote (directive)
PyEnchant
Pygments
Python
Python Enhancement Proposals
PEP 8
,
[1]
Q
Quotes
Sphinx Syntax
R
rack (directive)
Read the Docs
Sphinx Themes
ref (role)
Referencing
Sphinx Syntax
replace (directive)
reStructuredText
Reuse Content
Sphinx Syntax
RFC
RFC 1866
RFC 1984
RFC 2083
rfc (role)
rfc-reference (role)
Roles
Sphinx Syntax
rspan (role)
RST Epilog
Sphinx Syntax
RST Prolog
Sphinx Syntax
S
:stub-columns: (directive option)
flat-table (directive)
Seealso
Sphinx Admonitions
seealso (directive)
Semantic Descriptions and Referencing
Sphinx Syntax
seqdiag (directive)
Sequence Diagram
Sphinx Extension
Simple Table
Sphinx Syntax
Specific
Sphinx Admonitions
spelling (directive)
Spelling Checker
Sphinx Extension
spelling_word_list_filename
configuration value
Sphinx
Admonitions Additional
Admonitions Attention
Admonitions Caution
Admonitions Danger
Admonitions Error
Admonitions Generic
Admonitions Hint
Admonitions Important
Admonitions Note
Admonitions Seealso
Admonitions Specific
Admonitions Tip
Admonitions Warning
Extension Activity Diagram
Extension BibTeX Citations
Extension Block Diagram
Extension Block Diagram Family
Extension Email Obfuscate
Extension LinuxDoc
Extension Mathematical Plots
Extension Network Diagram
Extension Paneled Content
Extension PGF/TikZ LaTeX Pictures
Extension Program Output
Extension Sequence Diagram
Extension Spelling Checker
Extension Tabbed Content
Syntax Admonitions
Syntax Block Quotation
Syntax Citations
Syntax Code Blocks
Syntax Code Example
Syntax Comments
Syntax CSV Table
Syntax Definition Lists
Syntax Directives
,
[1]
Syntax Doctest Blocks
Syntax Domains
Syntax Downloadable Files
Syntax Explicit Markup
Syntax External Referencing
Syntax Field Lists
Syntax Figures
Syntax Files
Syntax Footnotes
Syntax Glossary
Syntax Grid Table
Syntax Header
Syntax Hyperlink
Syntax Images
Syntax Includes
Syntax Index
Syntax Inline Image
Syntax Inline Markup
Syntax Line Blocks
Syntax List Table
Syntax Lists, Definition Lists
Syntax Literalinclude
Syntax Mathematics
Syntax Naming
Syntax Ordered Lists
Syntax Other Semantic Markup
Syntax Paragraphs
Syntax Quotes
Syntax Referencing
Syntax Reuse Content
Syntax Roles
Syntax RST Epilog
Syntax RST Prolog
Syntax Semantic Descriptions and Referencing
Syntax Simple Table
Syntax Styled Reference
Syntax Substitutions
Syntax Table of Contents Tree
Syntax Tables
Syntax Term
Syntax Unordered Lists
Syntax Use of whitespace
Syntax User Interface
Themes Read the Docs
strong (role)
Styled Reference
Sphinx Syntax
subscript (role)
Substitutions
Sphinx Syntax
superscript (role)
SVG
Syntax
Admonitions, Sphinx
Block Quotation, Sphinx
Citations, Sphinx
Code Blocks, Sphinx
Code Example, Sphinx
Comments, Sphinx
CSV Table, Sphinx
Definition Lists, Sphinx
Directives, Sphinx
,
[1]
Doctest Blocks, Sphinx
Domains, Sphinx
Downloadable Files, Sphinx
Explicit Markup, Sphinx
External Referencing, Sphinx
Field Lists, Sphinx
Figures, Sphinx
Files, Sphinx
Footnotes, Sphinx
Glossary, Sphinx
Grid Table, Sphinx
Header, Sphinx
Hyperlink, Sphinx
Images, Sphinx
Includes, Sphinx
Index, Sphinx
Inline Image, Sphinx
Inline Markup, Sphinx
Line Blocks, Sphinx
List Table, Sphinx
Lists, Definition Lists, Sphinx
Literalinclude, Sphinx
Mathematics, Sphinx
Naming, Sphinx
Ordered Lists, Sphinx
Other Semantic Markup, Sphinx
Paragraphs, Sphinx
Quotes, Sphinx
Referencing, Sphinx
Reuse Content, Sphinx
Roles, Sphinx
RST Epilog, Sphinx
RST Prolog, Sphinx
Semantic Descriptions and Referencing, Sphinx
Simple Table, Sphinx
Styled Reference, Sphinx
Substitutions, Sphinx
Table of Contents Tree, Sphinx
Tables, Sphinx
Term, Sphinx
Unordered Lists, Sphinx
Use of whitespace, Sphinx
User Interface, Sphinx
T
tab (directive)
Tabbed Content
Sphinx Extension
table (directive)
Table of Contents Tree
Sphinx Syntax
Tables
Li-Pro.Net Sphinx Primer
Sphinx Syntax
tabs (directive)
tabularcolumns (directive)
Term
Sphinx Syntax
term (role)
TeX
Themes
Li-Pro.Net Sphinx Primer
Read the Docs, Sphinx
TikZ
tikz (directive)
(role)
Tip
Sphinx Admonitions
tip (directive)
title-reference (role)
toctree (directive)
U
:url: (directive option)
csv-table (directive)
Unordered Lists
Sphinx Syntax
Use of whitespace
Sphinx Syntax
User Interface
Sphinx Syntax
W
:widths: (directive option)
csv-table (directive)
flat-table (directive)
Warning
Sphinx Admonitions
warning (directive)
X
XML
Read the Docs
v: 0.0.4
Versions
latest
stable
0.0.4
0.0.3
0.0.2
0.0.1
Downloads
On Read the Docs
Project Home
Builds