mr-theme 0.1.1__tar.gz

mr_theme-0.1.1/.gitignore

@@ -0,0 +1,13 @@
+*~
+
+__pycache__
+*.egg-info
+_build
+dist
+
+.mypy_cache
+.ruff_cache
+
+.venv
+
+docs/build

mr_theme-0.1.1/.vscode/settings.json

@@ -0,0 +1,62 @@
+{
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        },
+        "editor.quickSuggestions": {
+            "comments": true,
+            "other": true,
+            "strings": true
+        }
+    },
+    "autoDocstring.docstringFormat": "numpy-notypes",
+    "autoDocstring.generateDocstringOnEnter": true,
+    "autoDocstring.quoteStyle": "'''",
+    "autoDocstring.startOnNewLine": false,
+    "editor.bracketPairColorization.independentColorPoolPerBracketType": true,
+    "editor.formatOnSave": true,
+    "editor.rulers": [
+        80,
+        111
+    ],
+    "evenBetterToml.formatter.allowedBlankLines": 2,
+    "files.associations": {
+        "*.html": "jinja-html"
+    },
+    "files.eol": "\n",
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "html.format.enable": false,
+    "iis.configDir": "",
+    "python.analysis.autoImportCompletions": true,
+    "python.analysis.completeFunctionParens": false,
+    "python.analysis.diagnosticMode": "workspace",
+    "python.analysis.enableParallelIndexing": false,
+    "python.analysis.enableTroubleshootMissingImports": true,
+    "python.analysis.extraPaths": [
+        "${workspace}/mindb"
+    ],
+    "python.analysis.importFormat": "relative",
+    // "python.analysis.includeAliasesFromUserFiles": true,
+    "python.analysis.includeExtraPathSymbolsInSymbolSearch": true,
+    // "python.analysis.inlayHints.callArgumentNames": "off",
+    "python.analysis.languageServerMode": "full",
+    "python.analysis.packageIndexDepths": [
+        {
+            "depth": 50,
+            "includeAllSymbols": true,
+            "name": "mindb"
+        }
+    ],
+    "python.analysis.supportDocstringTemplate": false,
+    "python.analysis.supportRestructuredText": true,
+    "python.analysis.typeCheckingMode": "off",
+    "python.analysis.userFileIndexingLimit": -1,
+    "python.terminal.activateEnvInCurrentTerminal": true,
+    "python.terminal.executeInFileDir": true,
+    "python.testing.pytestArgs": [],
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "terminal.integrated.scrollback": 2000
+}

mr_theme-0.1.1/CHANGELOG.rst

@@ -0,0 +1,41 @@
+=========
+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.1.0/>`__,
+and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__.
+
+
+[Unreleased]
+============
+
+Security
+--------
+
+Added
+-----
+
+Changed
+-------
+
+Fixed
+-----
+
+Deprecated
+----------
+
+Removed
+-------
+
+Know Issue
+----------
+
+
+[0.1.1] 2026-09-21
+==================
+
+Added
+-----
+First working implementation.

mr_theme-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael Rippstein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mr_theme-0.1.1/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: mr-theme
+Version: 0.1.1
+Summary: mr-theme: Sphinx HTML theme and matplotlib style sheets
+Author-email: Michael Rippstein <info@anatas.ch>
+Maintainer-email: Michael Rippstein <info@anatas.ch>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/anatas_ch/pyl_mrtheme2
+Project-URL: Bug Tracker, https://gitlab.com/anatas_ch/pyl_mrtheme2/-/issues
+Project-URL: Wiki, https://gitlab.com/anatas_ch/pyl_mrtheme2/-/wikis/home
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Sphinx :: Theme
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Matplotlib
+Requires-Python: >=3.14
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: sphinx<10.0,>=8.2.3
+Requires-Dist: sphinx-copybutton<1.0,>=0.5.2
+Requires-Dist: sphinx_design<1.0,>=0.6.1
+Requires-Dist: pydata-sphinx-theme<1.0,>=0.21.0
+Requires-Dist: sphinxcontrib-mermaid<3.0,>=2.1.1
+Provides-Extra: dev
+Requires-Dist: matplotlib<4.0,>=3.11.1; extra == "dev"
+Requires-Dist: ruff==0.16.6; extra == "dev"
+Requires-Dist: mypy>=1.19.0; extra == "dev"
+Requires-Dist: types-docutils<1,>=0.22.3; extra == "dev"
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
+Requires-Dist: build>=1.4.0; extra == "dev"
+Requires-Dist: twine>=6.2.0; extra == "dev"
+Requires-Dist: wheel>=0.45.1; extra == "dev"
+Requires-Dist: esbonio>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+===========================
+The Python Package MR-Theme
+===========================
+
+The package ``mr-theme`` provide a html-theme for sphinx-documentations
+and matplotlib style sheets.
+
+=========
+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.1.0/>`__,
+and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__.
+
+
+[Unreleased]
+============
+
+Security
+--------
+
+Added
+-----
+
+Changed
+-------
+
+Fixed
+-----
+
+Deprecated
+----------
+
+Removed
+-------
+
+Know Issue
+----------
+
+
+[0.1.1] 2026-09-21
+==================
+
+Added
+-----
+First working implementation.

mr_theme-0.1.1/README.rst

@@ -0,0 +1,6 @@
+===========================
+The Python Package MR-Theme
+===========================
+
+The package ``mr-theme`` provide a html-theme for sphinx-documentations
+and matplotlib style sheets.

mr_theme-0.1.1/cspell.json

@@ -0,0 +1,218 @@
+// cSpell Settings
+{
+        "version": "0.2",
+        "language": "en-GB",
+        "ignorePaths": [
+                "stubs"
+        ],
+        "words": [
+                "arcball",
+                "autodoc",
+                "autohint",
+                "autolayout",
+                "automargin",
+                "automodule",
+                "axisbelow",
+                "azel",
+                "bbox",
+                "bfit",
+                "bgdark",
+                "bglight",
+                "borderaxespad",
+                "borderpad",
+                "boxprops",
+                "capprops",
+                "capstyle",
+                "centered",
+                "chunksize",
+                "cmap",
+                "codeauthor",
+                "colormap",
+                "colormaps",
+                "colors",
+                "columnspacing",
+                "copybutton",
+                "corefonts",
+                "darkgray",
+                "darkslategray",
+                "dashdot",
+                "datetimez",
+                "dejavusans",
+                "dejavuserif",
+                "dialog",
+                "dirhtml",
+                "docstrings",
+                "Doctest",
+                "doctree",
+                "documentclass",
+                "edgecolor",
+                "edgecolors",
+                "eqref",
+                "errmsg",
+                "ERRORBAR",
+                "esbonio",
+                "facecolor",
+                "fancybox",
+                "figsize",
+                "fillstyle",
+                "flierprops",
+                "flynt",
+                "fontconfig",
+                "fontset",
+                "fontsize",
+                "fonttype",
+                "fontweight",
+                "framealpha",
+                "frameon",
+                "fulkerson",
+                "garde",
+                "Gedam",
+                "gridlines",
+                "guilabel",
+                "handleheight",
+                "handlelength",
+                "handletextpad",
+                "hashsalt",
+                "horizontalalignment",
+                "hspace",
+                "imshow",
+                "inheritcolor",
+                "inout",
+                "inputenc",
+                "intersphinx",
+                "ipynb",
+                "isort",
+                "joinstyle",
+                "jshtml",
+                "keymap",
+                "KEYMAPS",
+                "kwargs",
+                "labelbottom",
+                "labelcolor",
+                "labelleft",
+                "labellocation",
+                "labelpad",
+                "labelright",
+                "labelsize",
+                "labelspacing",
+                "labeltop",
+                "labelweight",
+                "lightgray",
+                "linenos",
+                "linestyle",
+                "literalinclude",
+                "markeredgecolor",
+                "markeredgewidth",
+                "markerfacecolor",
+                "markerscale",
+                "markersize",
+                "math",
+                "mathtext",
+                "matplotlib",
+                "MATPLOTLIBRC",
+                "mccabe",
+                "meanline",
+                "meanprops",
+                "medianprops",
+                "menuselection",
+                "minorticks",
+                "miter",
+                "modindex",
+                "moduleauthor",
+                "mouserotationstyle",
+                "mypy",
+                "nabla",
+                "ndivs",
+                "Neue",
+                "numfig",
+                "numpoints",
+                "numpy",
+                "numref",
+                "palatino",
+                "panecolor",
+                "papersize",
+                "patchartist",
+                "pathlib",
+                "pcolor",
+                "pcolormesh",
+                "perflint",
+                "polaraxes",
+                "Popen",
+                "Pradyun",
+                "productionlist",
+                "PSNFSS",
+                "pycache",
+                "pycodestyle",
+                "pydata",
+                "pydoclint",
+                "pydocstyle",
+                "pyflakes",
+                "pygrep",
+                "pylint",
+                "pyplot",
+                "pyproject",
+                "pytest",
+                "PYTHONPATH",
+                "pytz",
+                "pyupgrade",
+                "rcfonts",
+                "Rippstein",
+                "savefig",
+                "scatterpoints",
+                "sectionauthor",
+                "seealso",
+                "set_xlim",
+                "set_ylim",
+                "setuptools",
+                "showbox",
+                "showcaps",
+                "showfliers",
+                "showmeans",
+                "sphinxcontrib",
+                "staticmethod",
+                "stixsans",
+                "Subpackages",
+                "suptitle",
+                "templatename",
+                "texsystem",
+                "ticklabels",
+                "timezone",
+                "titlecolor",
+                "titlelocation",
+                "titlepad",
+                "titlesize",
+                "titlesonly",
+                "titleweight",
+                "toctree",
+                "toolmanager",
+                "trackballborder",
+                "trackballsize",
+                "tryceratops",
+                "typehints",
+                "useafm",
+                "usedistiller",
+                "useoffset",
+                "usetex",
+                "venv",
+                "verticalalignment",
+                "viewcode",
+                "webagg",
+                "whiskerprops",
+                "wspace",
+                "xaxis",
+                "xelatex",
+                "xmargin",
+                "xpdf",
+                "xscale",
+                "xtick",
+                "xticks",
+                "yaxis",
+                "ymargin",
+                "yscale",
+                "ytick",
+                "yticks",
+                "Zapf",
+                "zaxis",
+                "zmargin"
+        ]
+}

mr_theme-0.1.1/docs/Makefile

@@ -0,0 +1,26 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+api:
+	@sphinx-apidoc.exe --no-toc --force --remove-old --private --separate --module-first -d 2 -o "$(SOURCEDIR)/package_doc" "../src/mr_theme"
+
+labels:
+	@python -m sphinx.ext.intersphinx "$(BUILDDIR)/html/objects.inv" > ce_mobile.txt

mr_theme-0.1.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

mr_theme-0.1.1/docs/source/abbreviations.rst

@@ -0,0 +1,33 @@
+=============
+Abbreviations
+=============
+
+.. glossary::
+
+   .. 3
+   .. A
+   .. B
+   .. C
+   .. D
+   .. E
+   .. F
+   .. G
+   .. H
+   .. I
+   .. J
+   .. K
+   .. L
+   .. M
+   .. N
+   .. O
+   .. P
+   .. Q
+   .. R
+   .. S
+   .. T
+   .. U
+   .. V
+   .. W
+   .. X
+   .. Y
+   .. Z

mr_theme-0.1.1/docs/source/change_log.rst

@@ -0,0 +1,3 @@
+:orphan:
+
+.. include:: ../../CHANGELOG.rst

mr_theme-0.1.1/docs/source/conf.py

@@ -0,0 +1,141 @@
+"""Configuration file for the Sphinx documentation builder.
+
+For the full list of built-in configuration values, see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+.. moduleauthor:: Michael Rippstein <info@anatas.ch>
+
+:copyright: Copyright 2026 by Michael Rippstein.
+:license: MIT, see LICENSE for details.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import version as lib_version
+
+# -- Project information -----------------------------------------------------
+# region
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'MR-Theme Package'
+project_copyright = [
+    '2026-, Michael Rippstein',
+    'xxxx',
+]
+author = 'Michael Rippstein'
+
+release = lib_version('mr_theme')
+version = '.'.join(release.split('.')[:2])
+
+# endregion
+# -- General configuration ---------------------------------------------------
+# region
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx_copybutton',
+    'sphinx_design',
+    'sphinx.ext.autodoc',
+    # 'sphinx.ext.coverage',
+    # 'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.mermaid',
+    'matplotlib.sphinxext.plot_directive',
+]
+
+templates_path = ['_templates']
+
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+show_authors = True
+
+numfig = True
+numfig_format = {
+    'figure': 'Figure %s',
+    'table': 'Table %s',
+    'code-block': 'Listing %s',
+    'section': 'Section %s',
+}
+math_number_all = True
+math_eqref_format = '({number})'
+
+modindex_common_prefix = ['mr_theme.']
+
+add_module_names = False
+
+toc_object_entries_show_parents = 'hide'
+
+# endregion
+# -- Options for HTML output -------------------------------------------------
+# region
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'mr_theme'
+html_static_path = ['_static']
+
+html_short_title = f'mr-theme {release}'
+
+html_theme_options = {
+    'gitlab_url': 'https://gitlab.com/anatas_ch/pyl_mrtheme2',
+}
+
+html_static_path = ['_static']
+
+# html_logo = '_static/logo_mr_theme.svg'
+
+# endregion
+# -- Options for intersphinx extension ---------------------------------------
+# region
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+}
+
+# endregion
+# -- Options for Napoleon extension ------------------------------------------
+# region
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_keyword = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
+# endregion
+# -- Options for autodoc extension -------------------------------------------
+# region
+autodoc_default_options = {
+    'member-order': 'groupwise',
+    'exclude-members': '__weakref__, __module__, __doc__, __dict__',
+    'special-members': False,
+    'show-inheritance': True,
+}
+
+autodoc_member_order = 'bysource'
+autodoc_typehints = 'description'
+autodoc_typehints_format = 'short'
+
+# endregion
+# -- Options for todo extension -----------------------------------------------
+# region
+todo_include_todos = True
+
+# endregion
+# -- Options for mermaid extension --------------------------------------------
+# region
+
+# Enables zooming in all the generated Mermaid diagrams.
+mermaid_d3_zoom = True
+
+# endregion