Page layouts

Clarity Theme for Sphinx supports multiple page layouts suitable for different kinds of documentation, or parts of documentation. Layouts change overall page structure.

Default layout

Traditional three‑column: global table of contents (ToC) on the left, document content center, local ToC (“On this page”) on the right.

Compact layout

Two‑column: no global ToC; local ToC on the right. Suitable for README‑style or single‑page docs where a global ToC would be empty.

Changing layout

If you want to change layout, you can set it for a whole documentation or individual pages only.

Set layout globally

1. In conf.py’s html_theme_options, set default_layout option to layout name.

   html_theme_options = {
       "default_layout": "compact"
   }
   

Set layout per page (override global)

1. Add layout metadata at the top of the Markdown or reStructuredText document.

   RST

   :layout: compact
   
   Welcome to my project!
   ----------------------
   

   MD

   ---
   layout: compact
   ---
   
   # Welcome to my project!