Wagtail Sample¶

Quickstart¶

1. Install this theme:

   $ pip install sphinx-wagtail-theme
   

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

   extensions.append("sphinx_wagtail_theme")
   html_theme = 'sphinx_wagtail_theme'
   

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

Documentation¶

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

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.

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.

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.