mrtoolstheme 0.5.1

mrtoolstheme: a Sphinx theme

mrtoolstheme - A Sphinx HTML Theme

A Sphinx HTML Theme based on the arctic, north-bluish colour palette.

Usage

On Sphinx project’s conf.py: set the theme name to mrtools.

html_theme = "mrtools"

See details on Sphinx theming docs.

License

GNU AFFERO GENERAL PUBLIC LICENSE Version 3

Developer guide

Upgrade your setup tools and pip. They are needed for development and testing only:

pip install --upgrade setuptools pip wheel

Development steps for code changes

git clone https://gitlab.com/anatas_ch/pyl_mrtoolstheme.git
cd pyl_mrtoolstheme
pip install -e .

Then install relevant development requirements:

pip install -r requirements_rnd.txt

docs folder contains theme’s own documentation.

cd docs
make clean; make html

Once you have finished your changes, please provide test case(s) and relevant documentation.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

Changed

Fixed

[0.5.0] - 2023-02-04

Fixed

• description on PyPi

[0.5.0] - 2023-02-04

Changed

• minimal Python version: 3.9

• formatting long index entries

Fixed

• #3: Numbered lists in admonitions

• #4: Spacing around figure caption

• #5: Spacing around table captions

• #6: Harmonize horizontal spacing lists

[0.4.0] - 2022-02-18

Added

• formats for versionadded, versionchanged and deprecated

Changed

• formats for the python domain

[0.3.0] - 2021-11-05

Changed

• Table format: add top and bottom borders

• minimal Python version: 3.6

Fixed

• Doc: wrong version print out

• #2: Text as code formatted in a code-block caption

[0.2.0] - 2021-06-14

Added

• This CHANGELOG file.

Changed

• Documentation: Link to Read the Docs

Fixed

• #1: code-block in a admonition is not rendered properly

[0.1.0] - 2021-06-04

Added

• first public release.