pydata-sphinx-theme

(★ 776)

A clean, three-column Sphinx theme with Bootstrap for the PyData community

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- - a11y.yml
  - CI.yml
  - docs.yml
  - lighthouserc.json
  - link-check.yml
  - prerelease.yml
  - publish.yml
  - zizmor.yml
- dependabot.yml
- prerelease-template.md
- - component_directive.py
  - gallery_directive.py
- - 404.png
  - android-chrome-192x192.png
  - android-chrome-512x512.png
  - apple-touch-icon.png
  - contributors.yaml
  - custom-icons.js
  - custom.css
  - demo-expandable-navigation.gif
  - favicon-16x16.png
  - favicon-32x32.png
  - favicon.ico
  - gallery.yaml
  - logo-dark.svg
  - logo.svg
  - mstile-150x150.png
  - pull-request-preview-link.png
  - safari-pinned-tab.svg
  - switcher.json
  - theme-demo-screenshot.png
- - custom-template.html
  - edit-this-page.html
  - navbar-version.html
  - test.html
- - accessibility-statement.md
  - contributors.md
  - design-system.md
  - index.md
  - inspiration.md
  - setup.md
  - structure.md
- - execution.rst
  - gallery.md
  - graphviz.rst
  - in-page-toc.rst
  - index.rst
  - mermaid.rst
  - mult_headers.rst
  - no-sidebar.md
  - persistent-search-field.md
  - pydata.ipynb
  - regressions.rst
- - generate_collaborators_gallery.py
  - generate_gallery_images.py
  - update_kitchen_sink.py
- - ablog.md
  - accessibility.md
  - analytics.rst
  - announcements.rst
  - back-to-top.md
  - branding.rst
  - extending.rst
  - fonts.rst
  - header-links.rst
  - i18n.rst
  - index.md
  - indices.rst
  - install.rst
  - keyboard-shortcuts.md
  - layout.rst
  - light-dark.rst
  - navigation.rst
  - page-toc.rst
  - performance.rst
  - readthedocs.md
  - search.rst
  - source-buttons.rst
  - static_assets.md
  - styling.rst
  - theme-elements.md
  - version-dropdown.rst
  - warnings.rst
  - web-components.rst
- conf.py
- docutils.conf
- index.md
- jupyterlite_config.json
- - __init__.py
  - edit_this_page.py
  - logo.py
  - pygments.py
  - short_link.py
  - toctree.py
  - translator.py
  - utils.py
- - github_links.html
  - github_links_not_shortened.html
  - gitlab_links.html
  - gitlab_links_not_shortened.html
  - math_header_item.html
  - navbar_icon_links.html
  - navbar_ix.html
  - navbar_switcher.html
  - navbar_theme.html
  - sidebar_subpage.html
  - test_navbar_no_in_page_headers.html
  - test_sidebars_captions.html
  - test_sidebars_level2.html
  - test_sidebars_nested_page.html
  - test_toc_special_docnames_custom.html
  - test_toc_special_docnames_default.html
- - __init__.py
  - check_warnings.py
- __init__.py
- conftest.py
- intermittent_warning_list.txt
- README.md
- test_a11y.py
- test_build.py
- test_bump_version.py
- test_playwright.py
- test_short_url.py
- warning_list.txt
- bump_version.py
- divergent_links.py
- profile.py
.git-blame-ignore-revs
.gitignore
.pre-commit-config.yaml
.prettierignore
.readthedocs.yaml
.stylelintignore
.stylelintrc.yaml
.transifex.yaml
babel.cfg
CONTRIBUTING.md
LICENSE
package-lock.json
package.json
pyproject.toml
README.md
RELEASE.md
tox.ini
webpack.config.js

# Installation Guide

1. Get the code

git clone https://github.com/pydata/pydata-sphinx-theme

Downloads the entire project code from GitHub to your computer.

cd pydata-sphinx-theme

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install pydata-sphinx-theme

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install pydata-sphinx-theme

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.