Sphinx RTD theme demo Documentation Release 0.4.3 Dave Snider, Read the Docs, Inc. contributors Mar 06, 2019 Documentation 1 Via Python Package 1 2 Via Git or Download 3 3 ORDER 5 3.1 (ORDER)................................................5 3.1.1 Giant Tables...........................................8 4 Kenguru 9 4.1......................................................9 5 h1 Heading 8-) 11 5.1 h2 Heading................................................ 11 5.1.1 h3 Heading........................................... 11 5.1.1.1 h4 Heading....................................... 11 5.2 Horizontal Rules............................................. 11 5.3 Typographic replacements........................................ 11 5.4 Emphasis................................................. 12 5.5 Blockquotes............................................... 12 5.6 Lists................................................... 12 5.7 Code................................................... 13 5.8 Tables................................................... 13 5.9 Links................................................... 13 5.10 Images.................................................. 15 5.11 Plugins.................................................. 16 5.11.1 Emojies............................................. 16 5.11.2 Subscript / Superscript..................................... 17 5.11.3 <ins>.............................................. 17 5.11.4 <mark>............................................. 17 5.11.5 Footnotes............................................ 17 5.11.6 Definition lists......................................... 17 5.11.7 Abbreviations.......................................... 18 5.11.8 Custom containers....................................... 18 6 19 6.1...................................................... 19 i 7 Configuration 23 7.1 Project-wide Configuration....................................... 23 7.1.1 HTML Theme Options..................................... 23 7.1.1.1 Base options...................................... 23 7.1.1.2 TOC Options...................................... 24 7.1.2 HTML Context Options.................................... 24 7.2 Page-level Configuration......................................... 24 7.3 How the Table of Contents builds.................................... 24 8 Changelog 27 8.1 master.................................................. 27 8.1.1 New Features.......................................... 27 8.1.2 Fixes.............................................. 27 8.1.3 Other Changes......................................... 27 8.2 v0.4.2................................................... 27 8.2.1 New Features.......................................... 27 8.2.2 Fixes.............................................. 27 8.2.3 Other Changes......................................... 28 8.3 v0.4.1................................................... 28 8.3.1 New Features.......................................... 28 8.3.2 Fixes.............................................. 28 8.3.3 Other Changes......................................... 28 8.4 v0.4.0................................................... 28 8.4.1 New Features.......................................... 28 8.4.2 Fixes.............................................. 28 8.4.3 Other Changes......................................... 28 8.5 v0.3.1................................................... 28 8.5.1 Fixes.............................................. 28 8.6 v0.3.0................................................... 29 8.6.1 New Features.......................................... 29 8.6.2 Fixes.............................................. 29 8.6.3 Other Changes......................................... 29 8.7 v0.2.4................................................... 29 8.8 v0.2.3................................................... 30 8.9 v0.2.2................................................... 30 8.10 v0.2.1................................................... 30 8.11 v0.2.0................................................... 30 8.12 v0.1.10-alpha............................................... 30 8.13 v0.1.9................................................... 30 8.14 v0.1.8................................................... 31 9 Contributing or modifying the theme 33 9.1 Set up your environment......................................... 33 9.2 Releasing the Theme........................................... 34 10 Structural Elements 35 10.1 Document Section............................................ 36 10.1.1 Document Subsection...................................... 36 10.1.1.1 Document Subsubsection............................... 36 11 Structural Elements 2 37 11.1 Document Section............................................ 37 11.1.1 Document Subsection...................................... 37 12 Paragraph Level Markup 39 ii 12.1 Inline Markup.............................................. 40 12.2 Math................................................... 41 12.3 Meta................................................... 41 12.4 Blocks.................................................. 41 12.4.1 Literal Blocks.......................................... 41 12.4.2 Line Blocks........................................... 41 12.4.3 Block Quotes.......................................... 42 12.4.4 Doctest Blocks......................................... 42 12.4.5 Code Blocks........................................... 42 12.4.5.1 Emphasized lines with line numbers......................... 43 12.5 Sidebar.................................................. 43 12.5.1 Code with Sidebar....................................... 43 12.6 References................................................ 44 12.6.1 Footnotes............................................ 44 12.6.2 Citations............................................. 44 12.6.3 Glossary............................................. 45 12.6.4 Targets............................................. 45 12.7 Directives................................................. 45 12.7.1 Contents............................................. 45 12.7.2 Centered text.......................................... 45 12.7.3 Images & Figures........................................ 45 12.7.3.1 Images......................................... 45 12.7.3.2 Figures......................................... 45 12.7.4 Admonitions.......................................... 46 12.7.5 Topics, Sidebars, and Rubrics.................................. 47 12.7.6 Target Footnotes........................................ 48 12.7.7 Replacement Text........................................ 48 12.7.8 Compound Paragraph...................................... 48 12.8 Download Links............................................. 48 13 Lists & Tables 49 13.1 Lists................................................... 50 13.1.1 Enumerated Lists........................................ 50 13.1.2 Definition Lists......................................... 50 13.1.3 Option Lists........................................... 50 13.1.4 Field list............................................. 51 13.1.5 Bullet Lists........................................... 51 13.1.5.1 Second list level.................................... 52 13.1.6 Hlists.............................................. 52 13.1.7 Numbered List......................................... 53 13.2 Tables................................................... 53 13.2.1 Grid Tables........................................... 53 13.2.1.1 Giant Tables...................................... 54 13.2.2 List Tables............................................ 54 14 test_py_module 57 14.1 Generated Index............................................. 59 14.2 Optional parameter args......................................... 59 14.3 Data.................................................... 59 15 Long Sticky Nav 61 15.1 Example Menu 1............................................. 62 15.2 Example Menu 2............................................. 62 15.3 Example Menu 3............................................. 62 iii 15.4 Example Menu 4............................................. 62 15.5 Example Menu 5............................................. 63 15.6 Example Menu 6............................................. 63 15.7 Example Menu 7............................................. 63 15.8 Example Menu 8............................................. 63 15.9 Example Menu 9............................................. 63 15.10 Example Menu 10............................................ 63 15.11 Example Menu 11............................................ 63 15.12 Example Menu 12............................................ 63 15.13 Example Menu 13............................................ 63 15.14 Example Menu 14............................................ 63 15.15 Example Menu 15............................................ 64 15.16 Example Menu 16............................................ 64 15.17 Example Menu 17............................................ 64 15.18 Example Menu 18............................................ 64 15.19 Example Menu 19............................................ 64 15.20 Example Menu 20............................................ 64 15.21 Example Submenu 1........................................... 64 15.21.1 Submenu 1........................................... 64 15.21.1.1 Subsubmenu 1..................................... 64 15.21.1.2 Subsubmenu 2..................................... 64 15.21.2 Submenu 2..........................................