Metadata-Version: 2.4
Name: sphinx-gp-highlighting
Version: 0.0.1a33
Summary: Reusable Pygments lexers and inline highlighting for Sphinx
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: documentation,highlighting,pygments,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: docutils
Requires-Dist: pygments
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# 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

```console
$ pip install sphinx-gp-highlighting
```

## Usage

Enable the extension in `conf.py`:

```python
extensions = ["sphinx_gp_highlighting"]
```

Use the `tree` lexer for directory layouts:

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