Skip to main content
Help us improve Python packaging – donate today!

Sphinx extension for OS code-blocks

Project Description

Documentation Status

osexample extension for Sphinx

This is a modified fork of Serge Domkowski’s examplecode extension for Sphinx.


This is a simple extension that, when rendered as HTML, will fold multiple code blocks containing different operating systems administration examples into a single block which can be toggled from one to another using buttons.

It’s intended to be used for displaying package manager examples. (e.g., apt install or dnf install).

This extension adds the example-code directive which adds a class to a container wrapping the code blocks that should be folded. The class allows the included Javascript and CSS to render the folded block and buttons.

Currently supported are: Debian, Ubuntu, Fedora, CentOS, OSX

Quick Example

Source would look something like this:

.. example-code::
    .. code-block:: Debian

        sudo apt install htop

    .. code-block:: Fedora

        sudo dnf install htop

This will create an output like this:

Example how it looks like as generated HTML


$ pip install sphinxcontrib-osexample
Enabling the extension in Sphinx

Just add sphinxcontrib.examplecode to the list of extensions in the file. For example:

extensions = ['sphinxcontrib.osexample']


Full documentation for end users can be found in the “docs” folder.

It is also available online on Read The Docs


If you are having issues, please let us know.


The project is licensed under BSD.

Release history Release notifications

This version
History Node


History Node


History Node


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
sphinxcontrib-osexample-0.1.1.tar.gz (4.8 kB) Copy SHA256 hash SHA256 Source None Jan 15, 2016

Supported by

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