Socket
Socket
Sign inDemoInstall

mrtoolstheme

Package Overview
Dependencies
2
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    mrtoolstheme

mrtoolstheme: a Sphinx theme


Maintainers
1

Readme

mrtoolstheme - A Sphinx HTML Theme

A Sphinx HTML Theme based on the arctic, north-bluish colour palette <https://www.nordtheme.com/>_.

Usage

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

.. code:: python

html_theme = "mrtools"

See details on Sphinx theming docs <http://www.sphinx-doc.org/en/master/theming.html#using-a-theme>_.

License

GNU AFFERO GENERAL PUBLIC LICENSE Version 3

Developer guide

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

.. code:: bash

pip install --upgrade setuptools pip wheel

Development steps for code changes

.. code:: bash

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

Then install relevant development requirements:

.. code:: bash

pip install -r requirements_rnd.txt

docs folder contains theme's own documentation.

.. code:: bash

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 <https://keepachangelog.com/en/1.0.0/>, and this project adheres to Semantic Versioning <https://semver.org/spec/v2.0.0.html>.

[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.

Keywords

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc