An Insipid Sphinx Theme

Quick Start

1. Install the Python package insipid-sphinx-theme

2. Add html_theme = 'insipid' to your conf.py

3. Run Sphinx!

Online documentation (and example of use)

https://insipid-sphinx-theme.readthedocs.io/

Source code repository (and issue tracker)

https://github.com/mgeier/insipid-sphinx-theme/

License

BSD-2-Clause (same as Sphinx itself), for more information take a look at the LICENSE file.

SVG icons from Font Awesome, CC BY 4.0.

---

click here to see full table of contents

Part One – Documentation

• Introduction
  • Goals
  • Features
• Installation and Usage
• Configuration
  • Theme Settings
    • insipid Settings
    • basic Settings
    • Default Values
  • Sphinx Settings
  • Example
• Customization
  • Custom CSS files
  • Custom JavaScript Files
  • Custom Templates
  • Custom SVG Icons
  • Derive Your Own Theme
• Contributing
  • Development Installation
  • Building the Documentation
  • Auto-Generated Documentation for Pull Requests
• Version History
• Git Repository

---

Part Two – Showcase

• 1 Showcases
  • 1.1 This Documentation
  • 1.2 Further Showcases
• 2 Basic Formatting
  • 2.1 Paragraphs
  • 2.2 Compound Paragraphs
  • 2.3 Line Blocks
  • 2.4 Inline Markup
  • 2.5 Hyperlinks
  • 2.6 Footnotes
  • 2.7 Citations
  • 2.8 Other Semantic Markup
• 3 Images
  • 3.1 Image
  • 3.2 Scaled Image
  • 3.3 Figure
  • 3.4 Scaled Figure
• 4 Code Blocks
  • 4.1 Literal Blocks
  • 4.2 Quoted Literal Blocks
  • 4.3 code-block Directive
  • 4.4 parsed-literal Directive
  • 4.5 Doctest Blocks
  • 4.6 Nesting
• 5 Admonitions
  • 5.1 Specific Admonitions
  • 5.2 Generic Admonitions
  • 5.3 Topic
  • 5.4 Sidebar
  • 5.5 Admonition-like Constructs
  • 5.6 Nesting
  • 5.7 Overflow
• 6 Lists
  • 6.1 Bullet Lists
  • 6.2 Enumerated Lists
  • 6.3 hlist
  • 6.4 Definition Lists
  • 6.5 Glossary
  • 6.6 Field Lists
  • 6.7 Option Lists
  • 6.8 Grammars
• 7 Quotes
  • 7.1 Block Quotes
  • 7.2 Epigraphs
  • 7.3 Highlights
  • 7.4 Pull-Quotes
• 8 Tables
  • 8.1 Grid Tables
  • 8.2 Simple Tables
  • 8.3 CSV Tables
  • 8.4 List Tables
  • 8.5 Large Table
  • 8.6 Nesting
• 9 Math
  • 9.1 Math in Section Title: \(e^{i\pi} + 1 = 0\)
• 10 API Documentation
  • 10.1 Info Field Lists
    • send_message()
  • 10.2 Python
    • require()
    • hello_world()
    • __name__
    • MyException
    • MyClass
      • MyClass.enable()
      • MyClass.from_file()
      • MyClass.whatever()
      • MyClass.data
      • MyClass.decorate()
    • decorate()
    • compile()
  • 10.3 C
  • 10.4 C++
    • MyBase
    • MyClass
    • MyClass
    • array
    • array
    • array
    • my_method()
    • my_method()
    • operator[]()
    • operator bool()
    • foo()
    • MyClass()
    • print()
    • print()
    • my_member
    • my_other_member
    • a
    • pi
    • MyList
    • const_iterator
    • MyType
    • MyContainer
    • MyEnum
    • MySpecificEnum
    • MyScopedEnum
    • MyScopedVisibilityEnum
    • myEnumerator
    • myOtherEnumerator
    • MyUnion
    • Iterator
      • Iterator::r
    • Data
      • Data::@data
        • Data::@data::a
        • Data::@data::b
    • f()
    • f()
    • advance()
    • MySortedContainer
  • 10.5 JavaScript
    • $.getJSON()
    • MyAnimal
    • jsdata
    • jsobject.name
  • 10.6 reStructuredText
    • .. foo::
    • .. bar::
    • .. my-toctree::
      • :caption:
      • :glob:
    • :foo:
  • 10.7 The Standard Domain
    • 10.7.1 Program Options
    • 10.7.2 Environment Variables
    • 10.7.3 Generic Objects
  • 10.8 sphinx.ext.autodoc
    • setup()
    • TheBestClass
      • TheBestClass.multiplicate()
    • a_very_useful_function()
  • 10.9 sphinx.ext.autosummary
• 11 Sections
  • 11.1 Header Level 2
    • 11.1.1 Header Level 3
      • 11.1.1.1 Header Level 4
        • 11.1.1.1.1 Header Level 5
          • 11.1.1.1.1.1 Header Level 6
  • 11.2 Header Level 2
    • 11.2.1 Header Level 3
      • 11.2.1.1 Header Level 4
        • 11.2.1.1.1 Header Level 5
          • 11.2.1.1.1.1 Header Level 6
  • 11.3 Rubric
  • 11.4 Table of Contents
  • 11.5 Local Table of Contents
    • 11.5.1 Subsection One
      • 11.5.1.1 Subsubsection
    • 11.5.2 Subsection Two
  • 11.6 Nested toctree
    • 11.6.1 Nested Document With a Very, Very, Very, Very, Very, Very, Very Long Title
      • 11.6.1.1 Further<br>Nested”Document
    • An External URL
• 12 Another Top-Level Section
  • 12.1 Subsection
    • 12.1.1 Another Nested Document
• 13 Page With Different Sidebar
  • 13.1 Local Table of Contents
  • 13.2 Search Box
• 14 Page Without Sidebar

---

Index

Python Module Index

How To Navigate This Site

Use the next and previous links at the top and the bottom of each page to flip through the pages. Alternatively, you can use the right and left arrow keys on your keyboard. Some additional keyboard shortcuts are provided via the accesskey feature: n next, p previous, u up (= to the parent page), i index, s search and m menu (= open/close sidebar).

Click on the hamburger button in the topbar to open and close the sidebar. The width of the sidebar can be adjusted by dragging its border. Click on the title in the topbar to scroll to the top of the page, if already at the top, go “up” to the parent page (eventually ending up on this very page).

On touch-enabled devices: Tap at the top of the page to show the topbar (if it was scrolled away); swipe from the left edge to show the sidebar, swipe towards the left to hide it.