jjmachan/sphinxawesome-theme

Create beautiful and awesome websites with the Sphinx documentation generator.

Sphinx awesome theme

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

Get started

1. Install the theme as a Python package:

   pip install sphinxawesome-theme

   For more information, see Install the theme.

2. Add sphinxawesome_theme as an HTML theme in your Sphinx configuration file conf.py:

   html_theme = "sphinxawesome_theme"

   For more information, see Add your theme.

3. Optional: add bundled extensions for more awesome features:

   # conf.py
   extensions += ["sphinxawesome_theme.docsearch", "sphinxawesome.highlighting"]

Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.

Awesome code blocks

• Code block have a Copy button for copying the code.

• If you load the bundled sphinxawesome_theme.highlighting, you can use these additional options in your code-block directives:

  • 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.

Better headerlinks

Clicking the link icon after headers or captions automatically copies the URL to the clipboard.

DocSearch

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