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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/anatas_ch/pyl_mrtoolstheme",
"name": "mrtoolstheme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "syntax highlighting,sphinx doc theme",
"author": "Michael Rippstein",
"author_email": "info@anatas.ch",
"download_url": "https://files.pythonhosted.org/packages/de/0d/43b9fe0bf6cf88e246d28b62f3fd618fa56d2ce4cff42882305902040cd7/mrtoolstheme-0.5.1.tar.gz",
"platform": null,
"description": "mrtoolstheme - A Sphinx HTML Theme\n==================================\n\nA Sphinx HTML Theme based on the `arctic, north-bluish colour palette <https://www.nordtheme.com/>`_.\n\nUsage\n-----\n\nOn Sphinx project\u2019s ``conf.py``: set the theme name to ``mrtools``.\n\n.. code:: python\n\n html_theme = \"mrtools\"\n\nSee details on `Sphinx theming docs <http://www.sphinx-doc.org/en/master/theming.html#using-a-theme>`_.\n\nLicense\n-------\n\nGNU AFFERO GENERAL PUBLIC LICENSE Version 3\n\nDeveloper guide\n---------------\n\nUpgrade your setup tools and pip.\nThey are needed for development and testing only:\n\n.. code:: bash\n\n pip install --upgrade setuptools pip wheel\n\nDevelopment steps for code changes\n\n.. code:: bash\n\n git clone https://gitlab.com/anatas_ch/pyl_mrtoolstheme.git\n cd pyl_mrtoolstheme\n pip install -e .\n\nThen install relevant development requirements:\n\n.. code:: bash\n\n pip install -r requirements_rnd.txt\n\n`docs` folder contains theme's own documentation.\n\n.. code:: bash\n\n cd docs\n make clean; make html\n\nOnce you have finished your changes, please provide test case(s) and relevant documentation.\n\n=========\nChangelog\n=========\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`__,\nand this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__.\n\n\n[Unreleased]\n============\n\nAdded\n-----\n\nChanged\n-------\n\nFixed\n-----\n\n\n[0.5.0] - 2023-02-04\n====================\n\nFixed\n-----\n- description on PyPi\n\n\n[0.5.0] - 2023-02-04\n====================\n\nChanged\n-------\n- minimal Python version: 3.9\n- formatting long index entries\n\nFixed\n-----\n- #3: Numbered lists in admonitions\n- #4: Spacing around figure caption\n- #5: Spacing around table captions\n- #6: Harmonize horizontal spacing lists\n\n\n[0.4.0] - 2022-02-18\n====================\n\nAdded\n-----\n- formats for `versionadded`, `versionchanged` and `deprecated`\n\nChanged\n-------\n- formats for the python domain\n\n\n[0.3.0] - 2021-11-05\n====================\n\nChanged\n-------\n- Table format: add top and bottom borders\n- minimal Python version: 3.6\n\nFixed\n-----\n- Doc: wrong version print out\n- #2: Text as code formatted in a ``code-block`` ``caption``\n\n\n[0.2.0] - 2021-06-14\n====================\n\nAdded\n-----\n- This CHANGELOG file.\n\nChanged\n-------\n- Documentation: Link to Read the Docs\n\nFixed\n-----\n- #1: ``code-block`` in a ``admonition`` is not rendered properly\n\n\n[0.1.0] - 2021-06-04\n====================\n\nAdded\n-----\n- first public release.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "mrtoolstheme: a Sphinx theme",
"version": "0.5.1",
"split_keywords": [
"syntax highlighting",
"sphinx doc theme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f38cd31c9176f2cd5567c564537c88dea5889c6c3a161edb782da2486747a17",
"md5": "fb953200a6f051a4c3b253c1f1de27b5",
"sha256": "4d21427b48fbe9236245787ccf96a357f2ba9a92b15ec6efe0e39d49b70fc4f0"
},
"downloads": -1,
"filename": "mrtoolstheme-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb953200a6f051a4c3b253c1f1de27b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21224,
"upload_time": "2023-02-04T22:39:31",
"upload_time_iso_8601": "2023-02-04T22:39:31.954131Z",
"url": "https://files.pythonhosted.org/packages/4f/38/cd31c9176f2cd5567c564537c88dea5889c6c3a161edb782da2486747a17/mrtoolstheme-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de0d43b9fe0bf6cf88e246d28b62f3fd618fa56d2ce4cff42882305902040cd7",
"md5": "812cd2920716d4a59736efda8de1676f",
"sha256": "7256800ab5b979c2289a07b47a2b0e354a861bb58b458252074f1f7b29d90057"
},
"downloads": -1,
"filename": "mrtoolstheme-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "812cd2920716d4a59736efda8de1676f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 52669,
"upload_time": "2023-02-04T22:39:33",
"upload_time_iso_8601": "2023-02-04T22:39:33.833560Z",
"url": "https://files.pythonhosted.org/packages/de/0d/43b9fe0bf6cf88e246d28b62f3fd618fa56d2ce4cff42882305902040cd7/mrtoolstheme-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-04 22:39:33",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "anatas_ch",
"gitlab_project": "pyl_mrtoolstheme",
"lcname": "mrtoolstheme"
}
JSON