chios

A collection of Sphinx extensions.


Keywords
sphinx, documentation, extension, bold, italic, remote, code
License
GPL-3.0
Install
pip install chios==1.0.0

Documentation

chios

https://img.shields.io/pypi/status/chios.svg?style=flat https://img.shields.io/pypi/v/chios.svg?style=flat https://img.shields.io/badge/Python-3.7-brightgreen.svg?style=flat https://img.shields.io/badge/Python-3.8-brightgreen.svg?style=flat https://img.shields.io/badge/Python-3.9-brightgreen.svg?style=flat http://img.shields.io/badge/license-GPL-blue.svg?style=flat

chios is a collection of Sphinx extensions named after the Greek island Chios, whose symbol was the Sphinx.

Full documentation: https://kallimachos.github.io/chios/

Installation

Install chios using pip:

$ pip install chios

Extensions

bolditalic

Enables inline bold + italic text styling using a bolditalic role:

The end of this sentence :bolditalic:`displays in bold and italic`.

remotecode

Enables code blocks from remote sources using a remote-code-block directive:

.. remote-code-block:: ini

   https://example.com/rawsource.ini

remoteinclude

Enables RST file inclusion from remote sources using a remote-include directive:

.. remote-include:: https://example.com/rawsource.rst