Skip to main content

Reusable Pygments lexers and inline highlighting for Sphinx

Project description

sphinx-gp-highlighting

Reusable Sphinx highlighting helpers for git-pull documentation. The package ships Pygments lexers for documentation-oriented blocks and Sphinx inline literal helpers for commands, paths, and directories.

Install

$ pip install sphinx-gp-highlighting

Usage

Enable the extension in conf.py:

extensions = ["sphinx_gp_highlighting"]

Use the tree lexer for directory layouts:

```tree
python_module
├── package
│   └── __init__.py
└── pyproject.toml
```

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_gp_highlighting-0.0.1a33.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

sphinx_gp_highlighting-0.0.1a33-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_gp_highlighting-0.0.1a33.tar.gz.

File metadata

File hashes

Hashes for sphinx_gp_highlighting-0.0.1a33.tar.gz
Algorithm Hash digest
SHA256 6dfd4ac73478497f3e5a277a38b10698dd8d18819d404aa7a9e3aee5b901e19a
MD5 23e26e4bf5d49b6a033295867adda7b3
BLAKE2b-256 c664391a3cce536f5c94e27a9bfe8a2642b7a94db3c2ac888ab4b041813e2275

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_gp_highlighting-0.0.1a33.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_gp_highlighting-0.0.1a33-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_gp_highlighting-0.0.1a33-py3-none-any.whl
Algorithm Hash digest
SHA256 87e8411505d6f81af95c60d2053e3316c65ed6fee026ff3ad2e1c7180965650d
MD5 7c2710b4bc8e83588aef5e5623f99cdb
BLAKE2b-256 c843afaf5370f0992731e9c7554d51661b7328db3836c19549dabad73702a4b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_gp_highlighting-0.0.1a33-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