Skip to content
LogoAwesome Sphinx Theme
Docs About

How To

  • Install the theme
    • Install as a Python package
    • Install from a local directory
    • Create a local copy of the repository
  • Add the theme
    • Add the theme to your Sphinx configuration
    • Load the theme from a local directory
  • Configure the theme
    • Theme options
    • Extension options
    • Configure Algolia DocSearch
      • Algolia DocSearch credentials
      • Optional DocSearch settings
  • Customize the theme
    • Add custom CSS
      • Add CSS files
      • Extend templates with inline CSS
      • Override CSS custom properties
    • Add custom JavaScript
      • Add JavaScript files
      • Extend templates with inline JavaScript
    • Add custom templates
      • Extend templates
      • Extend template blocks
      • Add custom templates
      • Add custom page layouts
      • Available templates
  • Build your own theme
    • Prepare Python environment
    • Install the Python dependencies
    • Prepare JavaScript environment
    • Install JavaScript dependencies

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 or hide the highlighting language
      • Show line numbers in code blocks
      • Highlight lines in code blocks
      • Highlight changes in code blocks
      • Highlight placeholders 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
    • Topic
    • Notes
    • Warnings
    • Errors
    • Version changes
    • Block quotations
  • Sphinx design
    • Card
    • Grid
    • Dropdown
    • Tabs
    • Badges
    • Buttons
    • Inline icons
  • Headings and text
    • Inline markup
    • Level 2 heading
      • Level 3 heading

You're reading the documentation for version 4.1.0 of the theme. Switch to the latest version.

Awesome Sphinx Theme /Overview: module code

All modules for which code is available

  • docutils
    • docutils.nodes
© Kai Welke. Last updated: May 14, 2023. Made with Sphinx 6.2.1