Skip to main content

UNKNOWN

Project description

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 Sphinxcode-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.

Project details


Release history Release notifications

This version
History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx-classy-code-0.1.tar.gz (8.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page