Alabaster Sample

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

Important

This sample documentation was generated on Apr 15, 2024, and is rebuilt weekly.

Quickstart

1. Install this theme:

   $ pip install sphinx
   

2. Set the following in your existing Sphinx documentation’s conf.py file:

   html_theme = 'alabaster'
   

3. Build your Sphinx documentation with the new theme! [1]

Documentation

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

Exploration

The Kitchen Sink section contains pages that contains basically everything that you can with Sphinx “out-of-the-box”.

• Kitchen Sink
  • Admonitions
  • API documentation
  • Blocks
  • Generic items
  • Images & Figures
  • Lists
  • Really Long Page Title because we should test sidebar wrapping
  • Structural Elements
  • Structural Elements 2
  • Tables
  • Typography

Browsing through that section should give you a good idea of how stuff looks in this theme.

Navigation

This is the most important part of a documentation theme. If you like the general look of the theme, please make sure that it is possible to easily navigate through this sample documentation.

Ideally, the pages listed below should also be reachable via links somewhere else on this page (like the sidebar, or a topbar). If they are not, then this theme might need additional configuration to provide the sort of site navigation that’s necessary for “real” documentation.

This is a caption

• Placeholder Page One
• Placeholder Page Two
• This is just a page with a really long title for checking how the theme handles these situations
• Long Page
• External Link

Some pages like Placeholder Page Three are declared in a “hidden” toctree, and thus would not be visible above. However, they are still a part of the overall site hierarchy and some themes may choose to present them to the user in the site navigation.

---

[1]

If you hit an error while building documentation with a new theme, it is likely due to some theme-specific configuration in the conf.py file of that documentation. These are usually html_sidebars, html_theme_path or html_theme_config. Unsetting those will likely allow the build to proceed.