Skip to main content

Sphinx Classy Code

https://travis-ci.org/nyergler/sphinx-classy-code.png?branch=master https://coveralls.io/repos/nyergler/sphinx-classy-code/badge.png

Drop-in replacements for Sphinx‘ code-block and literalinclude directives. In addition to specifying emphasize-lines, you can specify arbitrary classes to add on a per-line basis.

For example:

.. code-block:: python
   :line-classes: 1(python-def)

   def stay(classy):
       pass

Will wrap the function declaration in <span class="python-def">...</span>.

Valid line + class specifiers include:

  • 1(classname)

  • 1-5(classname)

You can separate multiple specifiers with a comma.

You can use both line-classes and emphasize-lines in the same block.

Installation

To install, simply install the package:

$ pip install sphinx-classy-code

Then add it to the list of Sphinx extensions in your conf.py:

extensions = ['classycode']

License

sphinx-classy-code is made available under a BSD license; see LICENSE for details.

News

0.1

Release date: 16 March 2014

  • code-block supports line-classes option.

  • literalinclude supports line-classes option.

  • line-classes and emphasize-lines work together correctly.

Metadata

Release files for sphinx-classy-code 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-classy-code 0.1
File Size Uploaded
sphinx-classy-code-0.1.tar.gz 8.6 kB Details

Release files / sphinx-classy-code-0.1.tar.gz

Download URL sphinx-classy-code-0.1.tar.gz
Size 8.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d4a38be95fa07bb7122293982b4490375b34b1e365c8cc7951421e9967c5f053
BLAKE2b-256 checksum
How to use checksums
42a26e744da9671a5271e31e69aad8c7739983db718d09f0105da082153c0a60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page