Skip to content
LogoAwesome Sphinx Theme
Docs About

How-To

  • Install the theme
    • Install the theme as a Python package (recommended)
    • Install the theme from a local directory
    • Set up a development environment
      • Create a local copy of the repository
      • Install Python dependencies
      • Install JavaScript dependencies
  • Use the theme
    • Load the theme
      • Load the theme from a Python package
      • Load the theme from a local directory
    • Configure the theme
      • Theme options
      • Extension options
    • Make your documentation awesome
      • Use headerlink icons
      • Highlight placeholder text in code blocks
      • Highlight code changes
      • Add as-you-type search with Algolia DocSearch
  • Customize the theme
    • Add or override styles
    • Override CSS custom properties
    • Add page layouts
    • Override page layouts globally
    • Override per-page layout
  • Modify the theme
    • Modify the templates
    • Modify CSS files
  • Update the theme
    • Version 4.0
    • Version 3.0
    • Version 2.0

Demo

  • Module documentation
    • Automodule example
      • Package Structure
      • ApplicationError
      • Component
      • DataError
      • SettingsSpec
      • TransformSpec
      • VersionInfo
    • Autoclass example
      • Node
    • Autofunction example
      • serial_escape()
    • Command line options
      • Option directive
      • Option lists
  • Code blocks
    • Sphinx code-block directive
      • Add captions to code blocks
      • Show line numbers in code blocks
      • Highlight lines in code blocks
      • Highlight changes in code blocks
    • Docutils code directive
    • Parsed literal blocks
  • On-page navigation
    • Section 1
      • Subsection 1.1
      • Subsection 1.2
    • Section 2
      • Subsection 2.1
      • Subsection 2.2
  • Figures and tables
    • Images
    • Figures
    • Tables
  • Footnotes
  • Inline code
    • Syntax highlighting in inline code
    • More interpreted text roles
      • Files and directories
      • Inline code with placeholder text
      • Keyboard input
      • User interface elements
  • Lists
    • Unordered lists
    • Ordered lists
    • Definition lists
  • Notes, warnings, and quotations
    • Tips
    • Notes
    • Cautions
    • Warnings
    • Block quotations
  • Headings and text
    • Inline markup
    • Level 2 heading
      • Level 3 heading
Awesome Sphinx Theme /Use the theme

Use the theme

Learn how to add the Awesome Theme to your Sphinx documentation, how to configure the theme, and how to use its features.

in this section

  • Load the theme
  • Configure the theme
  • Make your documentation awesome
© Kai Welke. Last updated: Mar 26, 2023. Made with Sphinx 6.1.3