Awesome Sample#

This is a demo site for Awesome, generated as part of Sphinx Themes Gallery.

Important

This sample documentation was generated on Dec 05, 2021, and is rebuilt weekly.

Quickstart#

  1. Install this theme:

    python
    $ pip install sphinxawesome-theme
    
  2. Set the following in your existing Sphinx documentation’s conf.py file:

    python
    html_permalinks_icon = '<span>#</span>'
    html_theme = 'sphinxawesome_theme'
    
  3. Build your Sphinx documentation with the new theme! 1

Documentation#

You can find this theme’s documentation at https://sphinxawesome.xyz.

Exploration#

The Kitchen Sink section contains pages that contains basically everything that you can with Sphinx “out-of-the-box”. Browsing through that section should give you a good idea of how stuff looks in this theme.