mrtoolstheme

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.

Release files for mrtoolstheme 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mrtoolstheme 0.5.1
File	Size	Uploaded
mrtoolstheme-0.5.1.tar.gz	52.7 kB	Feb 4, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for mrtoolstheme 0.5.1
File	Interpreter	ABI	Platform	Reset
mrtoolstheme-0.5.1-py3-none-any.whl 21.2 kB Feb 4, 2023	Python 3	none	any	Details

Total release size: 73.9 kB

Release files / mrtoolstheme-0.5.1.tar.gz

Download URL	mrtoolstheme-0.5.1.tar.gz
Size	52.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`7256800ab5b979c2289a07b47a2b0e354a861bb58b458252074f1f7b29d90057`
BLAKE2b-256 checksum How to use checksums	`de0d43b9fe0bf6cf88e246d28b62f3fd618fa56d2ce4cff42882305902040cd7`
Upload date	Feb 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`

Release files / mrtoolstheme-0.5.1-py3-none-any.whl

Download URL	mrtoolstheme-0.5.1-py3-none-any.whl
Size	21.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4d21427b48fbe9236245787ccf96a357f2ba9a92b15ec6efe0e39d49b70fc4f0`
BLAKE2b-256 checksum How to use checksums	`4f38cd31c9176f2cd5567c564537c88dea5889c6c3a161edb782da2486747a17`
Upload date	Feb 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`