Sphinx extension for OS code-blocks
Project description
osexample extension for Sphinx
This is a modified fork of Serge Domkowski’s examplecode extension for Sphinx.
About
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:
Installation
$ 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']
Documentation
Full documentation for end users can be found in the “docs” folder.
It is also available online on Read The Docs
Contribute
Support
If you are having issues, please let us know.
License
The project is licensed under BSD.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-osexample-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab05432cb818def8566662cf4d4815d9f18bdf2bd1da386fb3b079fb59857cb9 |
|
MD5 | 7eefa1b3dc3a4a91aea515d4335ab988 |
|
BLAKE2b-256 | 4d062625bad796cf45065002b4144e7cef292e6d2ff45a5045b8b826798b2841 |