Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 1.98 KB

index.md

File metadata and controls

65 lines (48 loc) · 1.98 KB
myst html_theme.sidebar_secondary.remove
html_meta
description lang=en
Top-level documentation for pydata-sphinx theme, with links to the rest of the site..
true

The PyData Sphinx Theme

A clean, Bootstrap-based Sphinx theme by and for the PyData community.

:grid-columns: 1 2 2 3

- header: "{guilabel}`B` Built with Bootstrap"
  content: "Use Bootstrap classes and functionality in your documentation."
- header: "⚡ Responsive Design"
  content: "Site sections will change behavior and size at different screen sizes."
- header: "🌗 Light / Dark theme"
  content: "Users can toggle between light and dark themes interactively."
- header: "🎨 Customizable UI and themes"
  content: "Customize colors and branding with CSS variables, and build custom UIs with [Sphinx Design](user_guide/web-components)."
- header: "{fab}`python` Supports PyData and Jupyter"
  content: "CSS and UI support for Jupyter extensions and PyData execution outputs."
  link: "examples/pydata.html"
- header: "💡 Example Gallery"
  content: "See our gallery of projects that use this theme."
  link: "examples/gallery.html"
If you are looking for a Sphinx theme that puts all of its sub-pages in the sidebar, the [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/) has a similar look and feel, and [Furo](https://pradyunsg.me/furo/quickstart/) is another excellent choice. You can also see [the Sphinx Themes Gallery](https://sphinx-themes.org) for more ideas.

User Guide

Information about using, configuration, and customizing this theme.

:maxdepth: 2

user_guide/index

Community and contribution guide

Information about the community behind this theme and how you can contribute.

:maxdepth: 2

community/index

Examples

Several example pages to demonstrate the functionality of this theme when used alongside other Sphinx extensions.

:maxdepth: 2

examples/index