Skip to main content

A thin sphinx theme to customize pydata-sphinx-theme consistently cross PyMC websites.

Project description

pymc-sphinx-theme

A thin sphinx theme to customize pydata-sphinx-theme (PST) consistently cross PyMC websites.

Theme customizations

Custom search page

PyMC docs are organized as subprojects in readthedocs. The custom search page shows two search bars, one that triggers the readthedocs search function of the parent project and that allows searching accross subprojects, and the PST one for local search within that particular project only.

Search page with two search bars

Flyout of the global readthedocs search

Centralize navbar customization

The version indicator by the logo/project name is added as well as the mastodon, twitter, youtube and discord icon links. If no icon links are provided by the specific project, an extra link to the GitHub org is added, otherwise the project provided links are extended with the four mentioned.

Extra right sidebar elements

An extra "Support PyMC" link to the NumFOCUS donation page is automatically added, and the template of the "Edit on GitHub" link is modified so it is not shown in API pages that are generated from a docstring. The logic of this exclusion is extremely simple, as we use :toctree: generated/ as autosummary option, pages with "generated" in their path are excluded.

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

pymc_sphinx_theme-0.16.0.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymc_sphinx_theme-0.16.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file pymc_sphinx_theme-0.16.0.tar.gz.

File metadata

  • Download URL: pymc_sphinx_theme-0.16.0.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pymc_sphinx_theme-0.16.0.tar.gz
Algorithm Hash digest
SHA256 cbaf6b479f47f47ed840a8ad8e5af0ed32627d41a731d26419b520140e3ce13d
MD5 c93890622b4816215ff563fbc1fd44ca
BLAKE2b-256 050393bc2b6cc1f1d335bd73356bec2f3722c9d28aab2a0ba9582fd7baaafa9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymc_sphinx_theme-0.16.0.tar.gz:

Publisher: publish.yml on pymc-devs/pymc-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pymc_sphinx_theme-0.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pymc_sphinx_theme-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c86615610b1f533eb788b34bedb4f6fa9f9519e1820a8d1a4b14d1639091937
MD5 1ded446435bb077d2bf98371a8aa96c2
BLAKE2b-256 778f1ae86b3af6fdb4773f5e06888c13266a90cf63954aa1d6cbb466b5840263

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymc_sphinx_theme-0.16.0-py3-none-any.whl:

Publisher: publish.yml on pymc-devs/pymc-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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