Book Sample

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

Important

This sample documentation was generated on Jun 14, 2021, and is rebuilt weekly.

Quickstart

  1. Install this theme:

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

    html_theme = 'sphinx_book_theme'
    
  3. Build your Sphinx documentation with the new theme! 1

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.

You can find this theme’s documentation at https://sphinx-book-theme.readthedocs.io/en/latest/.