Skip to main content

Sphinx extension for self-hosted fonts via Fontsource CDN

Project description

sphinx-fonts

Sphinx extension for self-hosted fonts via Fontsource CDN.

Downloads font files at build time, caches them locally (~/.cache/sphinx-fonts), and injects @font-face declarations via Jinja2 template context.

Install

$ pip install sphinx-fonts

Usage

In your docs/conf.py:

extensions = ["sphinx_fonts"]

sphinx_fonts = [
    {
        "family": "IBM Plex Sans",
        "package": "@fontsource/ibm-plex-sans",
        "version": "5.2.8",
        "weights": [400, 500, 600, 700],
        "styles": ["normal", "italic"],
        "subset": "latin",
    },
]

sphinx_font_css_variables = {
    "--font-stack": '"IBM Plex Sans", sans-serif',
}

Requires a page.html template override that reads the font_faces and font_preload_hrefs context variables. See the gp-sphinx docs for a complete template example.

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

sphinx_fonts-0.0.1a13.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

sphinx_fonts-0.0.1a13-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_fonts-0.0.1a13.tar.gz.

File metadata

  • Download URL: sphinx_fonts-0.0.1a13.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_fonts-0.0.1a13.tar.gz
Algorithm Hash digest
SHA256 556ccaddaa81e7618ca72163d4f6c6e3179ae252d3c92637ccfd25837dfac38c
MD5 0b641c231dc8c7e5caf1c9cc1be3b09a
BLAKE2b-256 b0fc1e5a7a664e62745cb1d9a9251afffe1a6e081c96d3655bc1d9d89d9703fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_fonts-0.0.1a13.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

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

File details

Details for the file sphinx_fonts-0.0.1a13-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_fonts-0.0.1a13-py3-none-any.whl
Algorithm Hash digest
SHA256 3cc6f716547c9e46a9a8701b6b819f8d81d10e3ee91d94d6e006bb02e6534f38
MD5 e1225d75d1310baac32b1137235ba965
BLAKE2b-256 21ce9eea57147bcbc6474efbd7e43128a5222620891b78664a3c950160e05f0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_fonts-0.0.1a13-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

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