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
Currently supported are: Debian, Ubuntu, Fedora, CentOS, OSX
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:
$ pip install sphinxcontrib-osexample
Enabling the extension in Sphinx
Just add sphinxcontrib.examplecode to the list of extensions in the conf.py 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.