Skip to main content

Bootstrap-based Sphinx theme from the PyData community

Project description

pydata-sphinx-theme

A Bootstrap-based Sphinx theme from the PyData community.

Demo site: https://pydata-sphinx-theme.readthedocs.io/en/latest/

Note: This theme is originally being developed for the pandas docs (originally named "pandas-sphinx-theme"), but since there is uptake in other projects, we are working on making this more generic and more easily extensible to suit the needs of the different projects.

Sites that are using this theme:

Installation and usage

The theme is available on PyPI and conda-forge. You can install and use as follows:

  • Install the pydata-sphinx-theme in your doc build environment:

    pip install pydata-sphinx-theme
    # or
    conda install pydata-sphinx-theme --channel conda-forge
    
  • Then, in the conf.py of your sphinx docs, you update the html_theme configuration option:

    html_theme = "pydata_sphinx_theme"
    

And that's it!

Well, in principle at least. In practice, there are might still be a few pandas-specific things that are right now hard-coded in the theme. We also need to work on better configurability and extensibility. Feedback and contributions are very welcome!

Theme development

Contributions are very welcome! Installing the development version, building the demo docs and developing the css/js of the theme, etc, is explained in more detail in the contributing section of the documentation: https://pydata-sphinx-theme.readthedocs.io/en/latest/contributing.html

How is this theme working?

The html layout

The "layout" included in this theme is originally mainly targetted towards documentation sites with many pages, and where putting all navigation in a single sidebar can therefore get unwieldy.

The current layout features 3 navigation elements:

  • A top navbar with top-level navigation
  • A left sidebar with subsequent navigation up to single pages
  • A right sidebar with a local "On this page" table of contents

What is put where is determined by the sphinx "toctree" (and such depending on the structure of your sphinx docs). The first level of the toctree is put in the top navbar, and the second (and potentially) third level is put in the left sidebar.

It should certainly be possible to make the exact used levels of the sphinx toctree configurable.

Implementation details

A second aspect of the design of this theme is that we are trying to make good use of Bootstrap features and use as much as possible actual (templated) html and css to define the theme, instead of relying on sphinx to do custom formatting. This should make the theming and layouts more flexible to customize.

To this end, this package includes:

  • A BootstrapHTML5Translator, subclassing sphinx' translator, but overriding certain elements to generate Bootstrap-compatible html. Currently, this includes: converting admonitions to Bootstrap "alert" classes, and updating the classes used for html tables.
  • A sphinx event to add navigation objects into the html context which is available in the html (jinja2) templates. This allows to put the structure of the navigation elements in the actual layout, instead of having to rely on the hard-coded formatting of sphinx (this is inspired on the navigation objects of mkdocs: https://www.mkdocs.org/user-guide/custom-themes/#nav). We would love to see this added to sphinx itself (instead of needing a sphinx event), but for now did not yet get any reaction from the sphinx developers.

Those items also avoid writing javascript functions to "fix up" the html generated by sphinx to make it suitable for theming.

What's the difference with bootstrap-sphinx-theme ?

There is already a sphinx Bootstrap theme used by some project in the community: https://github.com/ryan-roemer/sphinx-bootstrap-theme/

Currently, the main difference is that this theme is using Bootstrap 4 instead of 3 and provides a different default layout. At some point, it would be good to contribute changes to that package (or at least the parts that deal with Bootstrap and sphinx that could be shared).

The initial layout and css were inspired on the Bootstrap documentation site.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydata-sphinx-theme-0.2.0.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

pydata_sphinx_theme-0.2.0-py2.py3-none-any.whl (38.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pydata-sphinx-theme-0.2.0.tar.gz.

File metadata

  • Download URL: pydata-sphinx-theme-0.2.0.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for pydata-sphinx-theme-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c9b3c894bd9592e6516e0e87dfd649fdfb3d9b8864c053f2b326db66e9980870
MD5 794808fe6b6b1992d1877e803844018f
BLAKE2b-256 d4f52f91978de29fca4192ecd2fc9f5d93ee7939f35846887b68e4179de4d083

See more details on using hashes here.

Provenance

File details

Details for the file pydata_sphinx_theme-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pydata_sphinx_theme-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for pydata_sphinx_theme-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 592922e3d2e7d1e45112e0f70648a879c3dcf70b4b5ec924a45f3ea3a2bfbb23
MD5 31f45532d7780a977dd2c58b8b853a58
BLAKE2b-256 c54860ac92cba7005363c698a63d86f426f17615fe5aab3e047b2ef5da9fbe61

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page