Skip to main content

An awesome theme for the Sphinx documentation generator

Project description

Sphinx awesome theme

MIT license PyPI version Netlify Deploy Lint

Create beautiful and awesome documentation websites with Sphinx. See how the theme looks like on sphinxawesome.xyz.

Get started

To use this theme for your documentation, install it via pip and add it to your Sphinx configuration.

  1. Install the theme as a Python package:

    pip install sphinxawesome-theme
    

    See How to install the theme for more information.

  2. Set html_theme in the Sphinx configuration file conf.py:

    html_theme = "sphinxawesome_theme"
    
  3. Add the theme as an extension in the Sphinx configuration file conf.py:

    extensions = ["sphinxawesome_theme"]
    

    See How to load the theme for more information.

For more information about configuring the theme for your use case, see How to configure the theme.

Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites. These features enhance the user experience:

Awesome code blocks

The code block shows the language of the code in a header. Each code block has a Copy button for easy copying. This theme enhances Sphinx's code-block directive with:

  • emphasize-added: highlight lines that should be added to code
  • emphasize-removed: highlight lines that should be removed from the code
  • emphasize-text: TEXT: highlight TEXT in the code block to emphasize placeholder text the user should replace.

Collapsible elements

Nested navigation links allow you to reach all pages from all other pages. You can make code object definitions, like methods, classes, or modules, collapsible as well, to focus on one item at a time.

Better headerlinks

Clicking the link icon after a header or caption automatically copies the URL to the clipboard.

DocSearch

If you have an Algolia DocSearch account for your documentation (it's free for open source projects), you can use DocSearch for a search-as-you-type experience with autocomplete.

Better keyboard navigation

Use the Tab key to quickly skip through all sections on the page. Use the Space key to expand or collapse items in the navigation menu or in code definitions.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxawesome-theme-3.3.7.tar.gz (462.9 kB view hashes)

Uploaded source

Built Distribution

sphinxawesome_theme-3.3.7-py3-none-any.whl (480.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page