From 46f2db070fbbeba741739357dc897a6989f596c7 Mon Sep 17 00:00:00 2001 From: Daniel Woste Date: Tue, 20 Dec 2022 14:18:14 +0100 Subject: [PATCH 01/14] Initial commit --- .gitignore | 129 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 130 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b6e4761 --- /dev/null +++ b/.gitignore @@ -0,0 +1,129 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e13e0b --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# useblocks-theme \ No newline at end of file From 815c0e493d99aedfb8c39e5d6b0985b009b0aff9 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Wed, 28 Dec 2022 20:32:31 +0000 Subject: [PATCH 02/14] Setup and added the initial Useblocks theme codes --- .gitignore | 4 +- README.md | 84 +++++++++++- ub_theme/__init__.py | 0 ub_theme/conf.py | 24 ++++ ub_theme/css/ub-theme.css | 144 +++++++++++++++++++++ ub_theme/js/ub-theme.js | 3 + ub_theme/templates/layout.html | 7 + ub_theme/templates/partials/copyright.html | 28 ++++ 8 files changed, 291 insertions(+), 3 deletions(-) create mode 100644 ub_theme/__init__.py create mode 100644 ub_theme/conf.py create mode 100644 ub_theme/css/ub-theme.css create mode 100644 ub_theme/js/ub-theme.js create mode 100644 ub_theme/templates/layout.html create mode 100644 ub_theme/templates/partials/copyright.html diff --git a/.gitignore b/.gitignore index b6e4761..2b710ed 100644 --- a/.gitignore +++ b/.gitignore @@ -69,8 +69,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ - +docs/ # PyBuilder target/ @@ -109,6 +108,7 @@ venv/ ENV/ env.bak/ venv.bak/ +.idea/ # Spyder project settings .spyderproject diff --git a/README.md b/README.md index 9e13e0b..32550d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,83 @@ -# useblocks-theme \ No newline at end of file +# useblocks-theme +This repository contains the theme for all Useblock documentation sites. + +> **NOTE:** Useblocks uses the Sphinx-Immaterial theme so ensure that the theme is already installed and applied. + +## Installation +To install the files from this repository, you must have [Git](https://git-scm.com) installed. + +* Change directory to your preferred docs working directory + ```bash + cd docs + ``` +* Download the files from the repository: + ```bash + git clone https://github.com/useblocks/useblocks-theme.git + ``` + +## Configuration + +You must configure the following in the **conf.py** file of the Sphinx documentation project. + +* Add the `html_theme_options` to your **conf.py**: + * Import the theme options for Useblocks. + ```python + from ub_theme.conf import html_theme_options + ``` + * Set it as the value for the `html_theme_options` variable. + ```python + html_theme_options = html_theme_options + ``` +* Add the custom template changes folder to the `templates_path` variable. + ```python + templates_path = ['ub_theme/templates'] + ``` +* Add custom CSS changes: + * Add the folder containing the CSS files to the `html_static_path` variable. + ```python + html_static_path = ["ub_theme/css"] + ``` + * Add the custom CSS files to the `html_css_files` variable. + ```python + html_css_files = ['ub-theme.css'] + ``` +* Add custom JS changes: + * Add the folder containing the JS files to the `html_static_path` variable. + ```python + html_static_path = ["ub_theme/js"] + ``` + * Add the custom JS files to the `html_js_files` variable. + ```python + html_js_files = ['ub-theme.js'] + ``` + +The final configuration should look like below: +```python +from ub_theme.conf import html_theme_options + +extensions = [ + "sphinx_immaterial", +] + +templates_path = ['ub_theme/templates'] + +html_theme = "sphinx_immaterial" +html_theme_options = html_theme_options + +# You can add other Sphinx-Immaterial theme options like below +other_options = { + "repo_url": "https://github.com/useblocks/useblocks-theme", + "repo_name": "useblocks-theme", + "repo_type": "github", +} +html_theme_options.update(other_options) + +html_static_path = ["ub_theme/css", "ub_theme/js"] +html_css_files = ['ub-theme.css'] +html_js_files = ['ub-theme.js'] + +``` + +## Changelog + +* 28.12.2022 - Setup and added the initial Useblocks theme codes diff --git a/ub_theme/__init__.py b/ub_theme/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ub_theme/conf.py b/ub_theme/conf.py new file mode 100644 index 0000000..bdb71d9 --- /dev/null +++ b/ub_theme/conf.py @@ -0,0 +1,24 @@ +html_theme_options = { + "icon": { + "repo": "fontawesome/brands/github", + }, + "font": { + "code": "JetBrains Mono", + "text": "Urbanist" + }, + "globaltoc_collapse": True, + "features": [ + "navigation.top", + "search.share", + "navigation.tracking", + "toc.follow", + "content.tabs.link" + ], + "palette": { + "scheme": "slate", + "primary": "yellow", + "accent": "yellow", + }, + "toc_title_is_page_title": True, + "toc_title": "Contents", +} diff --git a/ub_theme/css/ub-theme.css b/ub_theme/css/ub-theme.css new file mode 100644 index 0000000..793eec6 --- /dev/null +++ b/ub_theme/css/ub-theme.css @@ -0,0 +1,144 @@ +/* @import url('https://fonts.googleapis.com/css2?family=Recursive:wght@300;400&display=swap'); */ + +:root > * { + --md-primary-fg-color: #FFCC00; + --md-primary-fg-color--light: #ffeb9b; + --md-primary-fg-color--dark: #957700; +} + +td.needs_title { + font-weight: bold; +} + +.md-typeset pre, pre { + overflow-x: auto; +} + +div.wy-table-responsive{ + width: 100% !important; +} + +.underline{ + text-decoration: underline; +} + +/*Remove READTHEDOCS version badge*/ +.injected { + display: none !important; +} + +table.need{ + display: table !important; + width: 100% !important; +} +tbody tr td { + font-size: medium !important; +} + +/* Sphinx-Immaterial */ + +body, +input { + font-size: 18px !important; + font-weight: 400; + line-height: 1.5 !important; +} + +.md-typeset, .md-nav, .md-typeset table:not([class]) { + font-size: 18px !important; + line-height: 1.5 !important; +} + + +h1, h2, h3 { + font-weight: 500 !important; + line-height: 1.4 !important; +} + +h1:not([class="md-search-result__title"]) { + font-size: 34px !important; + margin-bottom: 20px !important; +} + +h2 { + font-size: 28px !important; + margin-bottom: 10px !important; +} + +h3 { + font-size: 24px !important; + margin-bottom: 10px !important; +} + +.dataTables_filter input { + border: 1px solid var(--md-typeset-color); + margin-bottom: 10px; + background-color: transparent; +} + +.border { + border: 1px solid var(--md-typeset-color); +} + +table.dataTable tbody tr { + background-color: transparent !important; +} + +.dataTables_wrapper .dataTables_length, .dataTables_wrapper .dataTables_filter, .dataTables_wrapper .dataTables_info, .dataTables_wrapper .dataTables_processing, .dataTables_wrapper .dataTables_paginate { + color: var(--md-typeset-color) !important; +} + +.dataTables_wrapper .dataTables_paginate a.paginate_button, .dataTables_wrapper .dataTables_paginate a.paginate_button.current { + color: var(--md-typeset-color) !important; +} + +div.dataTables_info { + margin-top: 0 !important; +} + +table tbody tr:hover { + background-color: rgb(147 147 147 / 10%) !important; + box-shadow: 0 .05rem 0 var(--md-default-bg-color) inset !important; +} + +button.dt-button:hover:not(.disabled), div.dt-button:hover:not(.disabled), a.dt-button:hover:not(.disabled) { + color: #000; +} + +.dataTables_wrapper .dataTables_filter { + float: left !important; + margin-left: 1% !important; +} + +div.dt-buttons { + margin-left: 1% !important; +} + +.dataTables_wrapper .dataTables_filter input { + max-width: 100px !important; +} +@media screen and (max-width: 640px){ + .dataTables_wrapper .dataTables_filter { + float: none !important; + text-align: center !important; + } + + .dataTables_wrapper .dataTables_filter input { + max-width: inherit !important; + } +} + +div.dt-button-collection button.dt-button.active:not(.disabled) { + color: #000 !important; + border: 1px solid #000 !important; +} + +table.NEEDS_DATATABLES, table.NEEDS_TABLE{ + max-width: inherit; + width: inherit; +} + +.md-header__button.md-logo :is(img, png) { + height: 2.2rem !important; +} + diff --git a/ub_theme/js/ub-theme.js b/ub_theme/js/ub-theme.js new file mode 100644 index 0000000..dad2c28 --- /dev/null +++ b/ub_theme/js/ub-theme.js @@ -0,0 +1,3 @@ +$(document).ready(function() { + $("table.NEEDS_DATATABLES, table.NEEDS_TABLE").wrap("
"); +}); \ No newline at end of file diff --git a/ub_theme/templates/layout.html b/ub_theme/templates/layout.html new file mode 100644 index 0000000..9a87a4f --- /dev/null +++ b/ub_theme/templates/layout.html @@ -0,0 +1,7 @@ +{# Import the theme's layout. #} +{% extends '!layout.html' %} + +{%- block extrahead %} + + {{ super() }} +{%- endblock %} diff --git a/ub_theme/templates/partials/copyright.html b/ub_theme/templates/partials/copyright.html new file mode 100644 index 0000000..2214d9d --- /dev/null +++ b/ub_theme/templates/partials/copyright.html @@ -0,0 +1,28 @@ +{#- + This file was automatically generated - do not edit +-#} +
+ {% if show_copyright %} +
+ {%- if hasdoc('copyright') %} + {% trans path=pathto('copyright'), copyright=copyright|e %}© + Copyright {{ copyright }}. + {% endtrans %} + {%- else %} +

Sponsored and maintained with 💛 by + {% trans copyright=copyright|e %} + {{ copyright }} + {% endtrans %} +

+ {%- endif %} +
+ {% endif %} + {%- if show_sphinx %} + {% trans sphinx_version=sphinx_version|e %}Created using + Sphinx + {{ sphinx_version }}. + {% endtrans %} and + Sphinx-Immaterial + {%- endif %} + {{ rendered_extracopyright }} +
From 1c9a52363259fa581871d0d82e677365780d06ec Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Fri, 13 Jan 2023 02:39:48 +0000 Subject: [PATCH 03/14] Updated CSS stylesheets and docs on how to apply the theme customization. --- README.md | 35 ++++++++++++++----- ub_theme/__init__.py => __init__.py | 0 ub_theme/conf.py => conf.py | 0 {ub_theme/css => css}/ub-theme.css | 11 ++++-- {ub_theme/js => js}/ub-theme.js | 0 {ub_theme/templates => templates}/layout.html | 0 .../partials/copyright.html | 8 ++--- 7 files changed, 37 insertions(+), 17 deletions(-) rename ub_theme/__init__.py => __init__.py (100%) rename ub_theme/conf.py => conf.py (100%) rename {ub_theme/css => css}/ub-theme.css (96%) rename {ub_theme/js => js}/ub-theme.js (100%) rename {ub_theme/templates => templates}/layout.html (100%) rename {ub_theme/templates => templates}/partials/copyright.html (62%) diff --git a/README.md b/README.md index 32550d3..9587e2f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # useblocks-theme This repository contains the theme for all Useblock documentation sites. -> **NOTE:** Useblocks uses the Sphinx-Immaterial theme so ensure that the theme is already installed and applied. +> **NOTE:** +> - Useblocks uses the Sphinx-Immaterial theme so ensure that the theme is already installed and applied. +> - Install `sphinx_immaterial` by running this command: `pip install sphinx-immaterial`. +> - Then activate the theme by adding it to the `extension` variable under **conf.py**: `extensions = ["sphinx_immaterial"]` +> - And change the `html_theme` variable to `html_theme = "sphinx_immaterial"` ## Installation To install the files from this repository, you must have [Git](https://git-scm.com) installed. @@ -19,6 +23,13 @@ To install the files from this repository, you must have [Git](https://git-scm.c You must configure the following in the **conf.py** file of the Sphinx documentation project. +* In order to import the **ub_theme** package, Python searches through the directories on `sys.path` looking for the package subdirectory. + * Add the parent path of the **ub_theme** folder to `sys.path`. + ```python + import os + import sys + sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file + ``` * Add the `html_theme_options` to your **conf.py**: * Import the theme options for Useblocks. ```python @@ -30,7 +41,7 @@ You must configure the following in the **conf.py** file of the Sphinx documenta ``` * Add the custom template changes folder to the `templates_path` variable. ```python - templates_path = ['ub_theme/templates'] + templates_path = ["_templates", "ub_theme/templates"] ``` * Add custom CSS changes: * Add the folder containing the CSS files to the `html_static_path` variable. @@ -39,7 +50,7 @@ You must configure the following in the **conf.py** file of the Sphinx documenta ``` * Add the custom CSS files to the `html_css_files` variable. ```python - html_css_files = ['ub-theme.css'] + html_css_files = ["ub-theme.css"] ``` * Add custom JS changes: * Add the folder containing the JS files to the `html_static_path` variable. @@ -48,18 +59,23 @@ You must configure the following in the **conf.py** file of the Sphinx documenta ``` * Add the custom JS files to the `html_js_files` variable. ```python - html_js_files = ['ub-theme.js'] + html_js_files = ["ub-theme.js"] ``` The final configuration should look like below: ```python +import sys +import os + +sys.path.append(os.path.abspath(".")) + from ub_theme.conf import html_theme_options extensions = [ "sphinx_immaterial", ] -templates_path = ['ub_theme/templates'] +templates_path = ["_templates", "ub_theme/templates"] html_theme = "sphinx_immaterial" html_theme_options = html_theme_options @@ -72,12 +88,13 @@ other_options = { } html_theme_options.update(other_options) -html_static_path = ["ub_theme/css", "ub_theme/js"] -html_css_files = ['ub-theme.css'] -html_js_files = ['ub-theme.js'] +html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] +html_css_files = ["ub-theme.css"] +html_js_files = ["ub-theme.js"] ``` ## Changelog -* 28.12.2022 - Setup and added the initial Useblocks theme codes +* 13.01.2023 - Updated CSS stylesheets and docs on how to apply the theme customization. +* 28.12.2022 - Setup and added the initial Useblocks theme codes. diff --git a/ub_theme/__init__.py b/__init__.py similarity index 100% rename from ub_theme/__init__.py rename to __init__.py diff --git a/ub_theme/conf.py b/conf.py similarity index 100% rename from ub_theme/conf.py rename to conf.py diff --git a/ub_theme/css/ub-theme.css b/css/ub-theme.css similarity index 96% rename from ub_theme/css/ub-theme.css rename to css/ub-theme.css index 793eec6..2f863b9 100644 --- a/ub_theme/css/ub-theme.css +++ b/css/ub-theme.css @@ -27,6 +27,10 @@ div.wy-table-responsive{ display: none !important; } +div.need_container { + overflow-x: auto; +} + table.need{ display: table !important; width: 100% !important; @@ -80,10 +84,14 @@ h3 { border: 1px solid var(--md-typeset-color); } +table.dataTable tbody tr { + background-color: transparent; +} +/* table.dataTable tbody tr { background-color: transparent !important; } - +*/ .dataTables_wrapper .dataTables_length, .dataTables_wrapper .dataTables_filter, .dataTables_wrapper .dataTables_info, .dataTables_wrapper .dataTables_processing, .dataTables_wrapper .dataTables_paginate { color: var(--md-typeset-color) !important; } @@ -141,4 +149,3 @@ table.NEEDS_DATATABLES, table.NEEDS_TABLE{ .md-header__button.md-logo :is(img, png) { height: 2.2rem !important; } - diff --git a/ub_theme/js/ub-theme.js b/js/ub-theme.js similarity index 100% rename from ub_theme/js/ub-theme.js rename to js/ub-theme.js diff --git a/ub_theme/templates/layout.html b/templates/layout.html similarity index 100% rename from ub_theme/templates/layout.html rename to templates/layout.html diff --git a/ub_theme/templates/partials/copyright.html b/templates/partials/copyright.html similarity index 62% rename from ub_theme/templates/partials/copyright.html rename to templates/partials/copyright.html index 2214d9d..7b50ba2 100644 --- a/ub_theme/templates/partials/copyright.html +++ b/templates/partials/copyright.html @@ -11,18 +11,14 @@ {%- else %}

Sponsored and maintained with 💛 by {% trans copyright=copyright|e %} - {{ copyright }} + © {{ copyright }} {% endtrans %}

{%- endif %} {% endif %} {%- if show_sphinx %} - {% trans sphinx_version=sphinx_version|e %}Created using - Sphinx - {{ sphinx_version }}. - {% endtrans %} and - Sphinx-Immaterial {%- endif %} {{ rendered_extracopyright }} + From 452ef0ecc878b23136697e1b2bb77a2e3c0f1973 Mon Sep 17 00:00:00 2001 From: Randy Duodu Date: Fri, 13 Jan 2023 02:41:44 +0000 Subject: [PATCH 04/14] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9587e2f..552262a 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ To install the files from this repository, you must have [Git](https://git-scm.c ```bash git clone https://github.com/useblocks/useblocks-theme.git ``` +* Delete both the **.git** hidden directory and **.gitignore** hidden file from the **ub_theme** folder. ## Configuration @@ -26,9 +27,9 @@ You must configure the following in the **conf.py** file of the Sphinx documenta * In order to import the **ub_theme** package, Python searches through the directories on `sys.path` looking for the package subdirectory. * Add the parent path of the **ub_theme** folder to `sys.path`. ```python - import os - import sys - sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file + import os + import sys + sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file ``` * Add the `html_theme_options` to your **conf.py**: * Import the theme options for Useblocks. From 51dc5b298027f200f1cd3a98ab29c029ca20b431 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Fri, 13 Jan 2023 07:06:28 +0000 Subject: [PATCH 05/14] Updated CSS & JS for documentation theme --- README.md | 4 ++-- css/ub-theme.css | 32 ++++++++++++++++++++++++++++++++ js/jquery.js | 2 ++ templates/layout.html | 2 +- 4 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 js/jquery.js diff --git a/README.md b/README.md index 552262a..ad506b4 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ You must configure the following in the **conf.py** file of the Sphinx documenta ``` * Add the custom JS files to the `html_js_files` variable. ```python - html_js_files = ["ub-theme.js"] + html_js_files = ["ub-theme.js", "jquery.js"] ``` The final configuration should look like below: @@ -91,7 +91,7 @@ html_theme_options.update(other_options) html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] html_css_files = ["ub-theme.css"] -html_js_files = ["ub-theme.js"] +html_js_files = ["ub-theme.js", "jquery.js"] ``` diff --git a/css/ub-theme.css b/css/ub-theme.css index 2f863b9..60adee5 100644 --- a/css/ub-theme.css +++ b/css/ub-theme.css @@ -104,6 +104,32 @@ div.dataTables_info { margin-top: 0 !important; } +div.dt-button-info{ + bottom:0.8rem; + left:1rem; + top:initial; + left:initial; + width:initial; + background-color:#e9ebfc; + border: 1px solid var(--md-typeset-color); + box-shadow:0 0.2rem 0.5rem rgba(0,0,0,.4),0 0 0.05rem rgba(0,0,0,.35); + border-radius:0.1rem; + text-align:left; + color: #2e303e; + min-width:11.1rem; + padding: 0.4rem 0.6rem; + pointer-events: none; + margin:0; +} +div.dt-button-info h2{ + display:none; +} +div.dt-button-info>div{ + padding:2px; + font-size: 18px!important; + color: #2e303e; +} + table tbody tr:hover { background-color: rgb(147 147 147 / 10%) !important; box-shadow: 0 .05rem 0 var(--md-default-bg-color) inset !important; @@ -149,3 +175,9 @@ table.NEEDS_DATATABLES, table.NEEDS_TABLE{ .md-header__button.md-logo :is(img, png) { height: 2.2rem !important; } + +@media screen and (min-width: 76.1875em){ + .md-nav__current-toc { + display: none!important; + } +} \ No newline at end of file diff --git a/js/jquery.js b/js/jquery.js new file mode 100644 index 0000000..200b54e --- /dev/null +++ b/js/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0 + {{ super() }} {%- endblock %} From 8535e74d591bda435eebc8c089d47b382e5404b3 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Sat, 14 Jan 2023 02:55:09 +0000 Subject: [PATCH 06/14] Updated CSS & JS for documentation theme --- conf.py | 27 +++++++++++++++++++++----- css/ub-theme.css | 45 ++++++++++++++++++++++++++++++++++++++++++- js/jquery.js | 2 -- templates/layout.html | 3 +-- 4 files changed, 67 insertions(+), 10 deletions(-) delete mode 100644 js/jquery.js diff --git a/conf.py b/conf.py index bdb71d9..c8544cb 100644 --- a/conf.py +++ b/conf.py @@ -14,11 +14,28 @@ "toc.follow", "content.tabs.link" ], - "palette": { - "scheme": "slate", - "primary": "yellow", - "accent": "yellow", - }, + "palette": [ + { + "media": "(prefers-color-scheme: light)", + "scheme": "default", + "primary": "yellow", + "accent": "yellow", + "toggle": { + "icon": "material/weather-night", + "name": "Switch to dark mode", + }, + }, + { + "media": "(prefers-color-scheme: dark)", + "scheme": "slate", + "primary": "yellow", + "accent": "yellow", + "toggle": { + "icon": "material/weather-sunny", + "name": "Switch to light mode", + }, + }, + ], "toc_title_is_page_title": True, "toc_title": "Contents", } diff --git a/css/ub-theme.css b/css/ub-theme.css index 60adee5..c74f118 100644 --- a/css/ub-theme.css +++ b/css/ub-theme.css @@ -6,6 +6,41 @@ --md-primary-fg-color--dark: #957700; } +/* Nav */ +.md-tabs { + background-color: #000; + color: #fff; + text-align: center; +} +.md-tabs__item span { + font-size: medium; + font-weight: 600; +} +.md-header { + background-color: var(--md-primary-fg-color); + color: #000; +} + +.md-top { + top: 70px!important; +} + +/*Light Mode*/ +[data-md-color-scheme=default]{ +--md-default-fg-color--light: #0000008a; +--img-filter: none; +} + +/*Night Mode*/ +[data-md-color-scheme=slate]{ +--md-default-fg-color--light: #d2d7f9; +--img-filter: brightness(0) invert(1); +} + +.md-typeset h1{ + color: var(--md-default-fg-color--light); +} + td.needs_title { font-weight: bold; } @@ -22,6 +57,11 @@ div.wy-table-responsive{ text-decoration: underline; } +figure[id^="needflow-"] { + overflow-x: auto; +} + + /*Remove READTHEDOCS version badge*/ .injected { display: none !important; @@ -38,6 +78,9 @@ table.need{ tbody tr td { font-size: medium !important; } +img.needs_image { + filter: var(--img-filter); +} /* Sphinx-Immaterial */ @@ -53,7 +96,6 @@ input { line-height: 1.5 !important; } - h1, h2, h3 { font-weight: 500 !important; line-height: 1.4 !important; @@ -74,6 +116,7 @@ h3 { margin-bottom: 10px !important; } +/* datatables */ .dataTables_filter input { border: 1px solid var(--md-typeset-color); margin-bottom: 10px; diff --git a/js/jquery.js b/js/jquery.js deleted file mode 100644 index 200b54e..0000000 --- a/js/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0 - {{ super() }} + {{ super() }} {%- endblock %} From df6b27d486b29ca13a9259fb09ec92e490404e0b Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Mon, 23 Jan 2023 01:41:20 +0000 Subject: [PATCH 07/14] Updated CSS for theme --- css/ub-theme.css | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/css/ub-theme.css b/css/ub-theme.css index c74f118..1ee2d51 100644 --- a/css/ub-theme.css +++ b/css/ub-theme.css @@ -20,7 +20,6 @@ background-color: var(--md-primary-fg-color); color: #000; } - .md-top { top: 70px!important; } @@ -36,7 +35,6 @@ --md-default-fg-color--light: #d2d7f9; --img-filter: brightness(0) invert(1); } - .md-typeset h1{ color: var(--md-default-fg-color--light); } @@ -44,19 +42,15 @@ td.needs_title { font-weight: bold; } - .md-typeset pre, pre { overflow-x: auto; } - div.wy-table-responsive{ width: 100% !important; } - .underline{ text-decoration: underline; } - figure[id^="needflow-"] { overflow-x: auto; } @@ -66,19 +60,20 @@ figure[id^="needflow-"] { .injected { display: none !important; } - div.need_container { overflow-x: auto; } - -table.need{ +table.need, .md-typeset table.data:not(.plain) { display: table !important; width: 100% !important; } +table { + border: 1px solid #e1e4e5 !important; +} tbody tr td { font-size: medium !important; } -img.needs_image { +img.needs_image, img.sn_collapse_img { filter: var(--img-filter); } @@ -91,11 +86,16 @@ input { line-height: 1.5 !important; } -.md-typeset, .md-nav, .md-typeset table:not([class]) { - font-size: 18px !important; +.md-typeset, .md-nav, .md-typeset table:not([class]), + .md-typeset table.data:not(.plain){ + font-size: 16px !important; line-height: 1.5 !important; } +.md-typeset :is(.admonition,details) { + font-size: 14px; +} + h1, h2, h3 { font-weight: 500 !important; line-height: 1.4 !important; @@ -223,4 +223,7 @@ table.NEEDS_DATATABLES, table.NEEDS_TABLE{ .md-nav__current-toc { display: none!important; } +} +details.sd-dropdown .sd-summary-up, details.sd-dropdown .sd-summary-down { + display: none; } \ No newline at end of file From c3c1bbfe4f24107d4e2468e785f08e8540c52783 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Mon, 23 Jan 2023 01:59:36 +0000 Subject: [PATCH 08/14] Updated CSS for theme, changelog and conf.py --- README.md | 15 ++++++++------- conf.py | 2 +- css/ub-theme.css | 2 +- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ad506b4..94210cf 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,11 @@ You must configure the following in the **conf.py** file of the Sphinx documenta * Add the `html_theme_options` to your **conf.py**: * Import the theme options for Useblocks. ```python - from ub_theme.conf import html_theme_options + from ub_theme.conf import ub_html_theme_options ``` * Set it as the value for the `html_theme_options` variable. ```python - html_theme_options = html_theme_options + html_theme_options = ub_html_theme_options ``` * Add the custom template changes folder to the `templates_path` variable. ```python @@ -60,17 +60,17 @@ You must configure the following in the **conf.py** file of the Sphinx documenta ``` * Add the custom JS files to the `html_js_files` variable. ```python - html_js_files = ["ub-theme.js", "jquery.js"] + html_js_files = ["ub-theme.js"] ``` The final configuration should look like below: ```python -import sys import os +import sys sys.path.append(os.path.abspath(".")) -from ub_theme.conf import html_theme_options +from ub_theme.conf import ub_html_theme_options extensions = [ "sphinx_immaterial", @@ -79,7 +79,7 @@ extensions = [ templates_path = ["_templates", "ub_theme/templates"] html_theme = "sphinx_immaterial" -html_theme_options = html_theme_options +html_theme_options = ub_html_theme_options # You can add other Sphinx-Immaterial theme options like below other_options = { @@ -91,11 +91,12 @@ html_theme_options.update(other_options) html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] html_css_files = ["ub-theme.css"] -html_js_files = ["ub-theme.js", "jquery.js"] +html_js_files = ["ub-theme.js"] ``` ## Changelog +* 23.01.2023 - Updated CSS for theme, changelog and conf.py * 13.01.2023 - Updated CSS stylesheets and docs on how to apply the theme customization. * 28.12.2022 - Setup and added the initial Useblocks theme codes. diff --git a/conf.py b/conf.py index c8544cb..04db69d 100644 --- a/conf.py +++ b/conf.py @@ -1,4 +1,4 @@ -html_theme_options = { +ub_html_theme_options = { "icon": { "repo": "fontawesome/brands/github", }, diff --git a/css/ub-theme.css b/css/ub-theme.css index 1ee2d51..53b1d1f 100644 --- a/css/ub-theme.css +++ b/css/ub-theme.css @@ -88,7 +88,7 @@ input { .md-typeset, .md-nav, .md-typeset table:not([class]), .md-typeset table.data:not(.plain){ - font-size: 16px !important; + font-size: 18px !important; line-height: 1.5 !important; } From d7848102d229c6a08f6d78e3e2e01b96b45277d9 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Mon, 23 Jan 2023 04:11:21 +0000 Subject: [PATCH 09/14] Updated project documentation to use the Useblocks theme customization. --- docs/changelog.rst | 3 +- docs/conf.py | 39 +-- docs/doc-requirements.txt | 3 +- docs/index.rst | 10 +- docs/ub_theme/README.md | 102 ++++++++ docs/ub_theme/__init__.py | 0 docs/ub_theme/conf.py | 41 ++++ docs/ub_theme/css/ub-theme.css | 229 ++++++++++++++++++ docs/ub_theme/js/ub-theme.js | 3 + docs/ub_theme/templates/layout.html | 6 + .../templates/partials/copyright.html | 24 ++ 11 files changed, 436 insertions(+), 24 deletions(-) create mode 100644 docs/ub_theme/README.md create mode 100644 docs/ub_theme/__init__.py create mode 100644 docs/ub_theme/conf.py create mode 100644 docs/ub_theme/css/ub-theme.css create mode 100644 docs/ub_theme/js/ub-theme.js create mode 100644 docs/ub_theme/templates/layout.html create mode 100644 docs/ub_theme/templates/partials/copyright.html diff --git a/docs/changelog.rst b/docs/changelog.rst index d10f685..6433b76 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,7 +5,8 @@ Release 1.6 ----------- :released: under development -* **Bugfix** [#60] Fix TOC hrefs for sections that use file title anchors. +* **Improvement**: Updated project documentation to use the Useblocks theme customization. +* **Bugfix**: [#60] Fix TOC hrefs for sections that use file title anchors. Release 1.5 ----------- diff --git a/docs/conf.py b/docs/conf.py index 9809219..df4ff43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,6 +9,11 @@ import os import sphinx import datetime +import sys + +sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file + +from ub_theme.conf import ub_html_theme_options project = 'Sphinx-SimplePDF' copyright = '2022, team useblocks' @@ -21,12 +26,13 @@ 'sphinx_simplepdf', 'sphinxcontrib.plantuml', 'sphinxcontrib.needs', + 'sphinx_immaterial', 'sphinx_copybutton', ] version = "1.6" -templates_path = ['_templates'] +templates_path = ["_templates", "ub_theme/templates"] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] plantuml_output_format = "svg_img" @@ -41,27 +47,29 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -#html_theme = 'sphinx_immaterial' -html_theme = 'alabaster' -#html_theme = 'sphinx_needs_pdf' -html_static_path = ['_static'] - -html_theme_options = { - 'github_user': 'useblocks', - 'github_repo': 'sphinx-simplepdf', - 'fixed_sidebar': True, - 'github_banner': True, - 'github_button': False, +html_theme = 'sphinx_immaterial' +html_title = 'Sphinx-SimplePDF' +# html_theme = 'alabaster' +# html_theme = 'sphinx_needs_pdf' + +html_theme_options = ub_html_theme_options +# You can add other Sphinx-Immaterial theme options like below +other_options = { + "repo_url": "https://github.com/useblocks/sphinx-simplepdf", + "repo_name": "sphinx-simplepdf", + "repo_type": "github", } +html_theme_options.update(other_options) html_context = { 'docs_scope': 'external', - 'cover_logo_title': '', 'cover_meta_data': 'The simple PDF builder for Sphinx.', - 'cover_footer': f'Build: {datetime.datetime.now().strftime("%d.%m.%Y")}
' - f'Maintained by team useblocks', } +html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] +html_css_files = ["ub-theme.css"] +html_js_files = ["ub-theme.js"] + def setup_jquery(app, exception): """ @@ -83,4 +91,3 @@ def setup_jquery(app, exception): } )) app.config.html_js_files = html_js_files - diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index 067b274..3906271 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,4 +1,5 @@ sphinx==5.1.1 sphinxcontrib-plantuml==0.24 sphinxcontrib-needs==0.7.8 -sphinx-copybutton \ No newline at end of file +sphinx-copybutton +sphinx-immaterial \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index a1ce0b6..4e6b551 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,10 +10,9 @@ This Sphinx extension provides an easy way to build beautiful PDFs based on CSS It contains: - * A PDF specific, CSS based Sphinx theme: ``sphinx_simplepdf``. - * A Sphinx builder, called ``simplepdf`` - * :ref:`Directives ` to - +* A PDF specific, CSS based Sphinx theme: ``sphinx_simplepdf``. +* A Sphinx builder, called ``simplepdf`` +* :ref:`Directives ` to * control different structures and content for ``HTML`` and ``PDF`` builds. * embed PDF inside HTML views. @@ -90,7 +89,6 @@ Showcase .. toctree:: - :caption: Content :maxdepth: 3 installation @@ -99,6 +97,6 @@ Showcase directives css tech_details - examples/index + examples/sphinx_needs changelog license \ No newline at end of file diff --git a/docs/ub_theme/README.md b/docs/ub_theme/README.md new file mode 100644 index 0000000..94210cf --- /dev/null +++ b/docs/ub_theme/README.md @@ -0,0 +1,102 @@ +# useblocks-theme +This repository contains the theme for all Useblock documentation sites. + +> **NOTE:** +> - Useblocks uses the Sphinx-Immaterial theme so ensure that the theme is already installed and applied. +> - Install `sphinx_immaterial` by running this command: `pip install sphinx-immaterial`. +> - Then activate the theme by adding it to the `extension` variable under **conf.py**: `extensions = ["sphinx_immaterial"]` +> - And change the `html_theme` variable to `html_theme = "sphinx_immaterial"` + +## Installation +To install the files from this repository, you must have [Git](https://git-scm.com) installed. + +* Change directory to your preferred docs working directory + ```bash + cd docs + ``` +* Download the files from the repository: + ```bash + git clone https://github.com/useblocks/useblocks-theme.git + ``` +* Delete both the **.git** hidden directory and **.gitignore** hidden file from the **ub_theme** folder. + +## Configuration + +You must configure the following in the **conf.py** file of the Sphinx documentation project. + +* In order to import the **ub_theme** package, Python searches through the directories on `sys.path` looking for the package subdirectory. + * Add the parent path of the **ub_theme** folder to `sys.path`. + ```python + import os + import sys + sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file + ``` +* Add the `html_theme_options` to your **conf.py**: + * Import the theme options for Useblocks. + ```python + from ub_theme.conf import ub_html_theme_options + ``` + * Set it as the value for the `html_theme_options` variable. + ```python + html_theme_options = ub_html_theme_options + ``` +* Add the custom template changes folder to the `templates_path` variable. + ```python + templates_path = ["_templates", "ub_theme/templates"] + ``` +* Add custom CSS changes: + * Add the folder containing the CSS files to the `html_static_path` variable. + ```python + html_static_path = ["ub_theme/css"] + ``` + * Add the custom CSS files to the `html_css_files` variable. + ```python + html_css_files = ["ub-theme.css"] + ``` +* Add custom JS changes: + * Add the folder containing the JS files to the `html_static_path` variable. + ```python + html_static_path = ["ub_theme/js"] + ``` + * Add the custom JS files to the `html_js_files` variable. + ```python + html_js_files = ["ub-theme.js"] + ``` + +The final configuration should look like below: +```python +import os +import sys + +sys.path.append(os.path.abspath(".")) + +from ub_theme.conf import ub_html_theme_options + +extensions = [ + "sphinx_immaterial", +] + +templates_path = ["_templates", "ub_theme/templates"] + +html_theme = "sphinx_immaterial" +html_theme_options = ub_html_theme_options + +# You can add other Sphinx-Immaterial theme options like below +other_options = { + "repo_url": "https://github.com/useblocks/useblocks-theme", + "repo_name": "useblocks-theme", + "repo_type": "github", +} +html_theme_options.update(other_options) + +html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] +html_css_files = ["ub-theme.css"] +html_js_files = ["ub-theme.js"] + +``` + +## Changelog + +* 23.01.2023 - Updated CSS for theme, changelog and conf.py +* 13.01.2023 - Updated CSS stylesheets and docs on how to apply the theme customization. +* 28.12.2022 - Setup and added the initial Useblocks theme codes. diff --git a/docs/ub_theme/__init__.py b/docs/ub_theme/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/docs/ub_theme/conf.py b/docs/ub_theme/conf.py new file mode 100644 index 0000000..04db69d --- /dev/null +++ b/docs/ub_theme/conf.py @@ -0,0 +1,41 @@ +ub_html_theme_options = { + "icon": { + "repo": "fontawesome/brands/github", + }, + "font": { + "code": "JetBrains Mono", + "text": "Urbanist" + }, + "globaltoc_collapse": True, + "features": [ + "navigation.top", + "search.share", + "navigation.tracking", + "toc.follow", + "content.tabs.link" + ], + "palette": [ + { + "media": "(prefers-color-scheme: light)", + "scheme": "default", + "primary": "yellow", + "accent": "yellow", + "toggle": { + "icon": "material/weather-night", + "name": "Switch to dark mode", + }, + }, + { + "media": "(prefers-color-scheme: dark)", + "scheme": "slate", + "primary": "yellow", + "accent": "yellow", + "toggle": { + "icon": "material/weather-sunny", + "name": "Switch to light mode", + }, + }, + ], + "toc_title_is_page_title": True, + "toc_title": "Contents", +} diff --git a/docs/ub_theme/css/ub-theme.css b/docs/ub_theme/css/ub-theme.css new file mode 100644 index 0000000..53b1d1f --- /dev/null +++ b/docs/ub_theme/css/ub-theme.css @@ -0,0 +1,229 @@ +/* @import url('https://fonts.googleapis.com/css2?family=Recursive:wght@300;400&display=swap'); */ + +:root > * { + --md-primary-fg-color: #FFCC00; + --md-primary-fg-color--light: #ffeb9b; + --md-primary-fg-color--dark: #957700; +} + +/* Nav */ +.md-tabs { + background-color: #000; + color: #fff; + text-align: center; +} +.md-tabs__item span { + font-size: medium; + font-weight: 600; +} +.md-header { + background-color: var(--md-primary-fg-color); + color: #000; +} +.md-top { + top: 70px!important; +} + +/*Light Mode*/ +[data-md-color-scheme=default]{ +--md-default-fg-color--light: #0000008a; +--img-filter: none; +} + +/*Night Mode*/ +[data-md-color-scheme=slate]{ +--md-default-fg-color--light: #d2d7f9; +--img-filter: brightness(0) invert(1); +} +.md-typeset h1{ + color: var(--md-default-fg-color--light); +} + +td.needs_title { + font-weight: bold; +} +.md-typeset pre, pre { + overflow-x: auto; +} +div.wy-table-responsive{ + width: 100% !important; +} +.underline{ + text-decoration: underline; +} +figure[id^="needflow-"] { + overflow-x: auto; +} + + +/*Remove READTHEDOCS version badge*/ +.injected { + display: none !important; +} +div.need_container { + overflow-x: auto; +} +table.need, .md-typeset table.data:not(.plain) { + display: table !important; + width: 100% !important; +} +table { + border: 1px solid #e1e4e5 !important; +} +tbody tr td { + font-size: medium !important; +} +img.needs_image, img.sn_collapse_img { + filter: var(--img-filter); +} + +/* Sphinx-Immaterial */ + +body, +input { + font-size: 18px !important; + font-weight: 400; + line-height: 1.5 !important; +} + +.md-typeset, .md-nav, .md-typeset table:not([class]), + .md-typeset table.data:not(.plain){ + font-size: 18px !important; + line-height: 1.5 !important; +} + +.md-typeset :is(.admonition,details) { + font-size: 14px; +} + +h1, h2, h3 { + font-weight: 500 !important; + line-height: 1.4 !important; +} + +h1:not([class="md-search-result__title"]) { + font-size: 34px !important; + margin-bottom: 20px !important; +} + +h2 { + font-size: 28px !important; + margin-bottom: 10px !important; +} + +h3 { + font-size: 24px !important; + margin-bottom: 10px !important; +} + +/* datatables */ +.dataTables_filter input { + border: 1px solid var(--md-typeset-color); + margin-bottom: 10px; + background-color: transparent; +} + +.border { + border: 1px solid var(--md-typeset-color); +} + +table.dataTable tbody tr { + background-color: transparent; +} +/* +table.dataTable tbody tr { + background-color: transparent !important; +} +*/ +.dataTables_wrapper .dataTables_length, .dataTables_wrapper .dataTables_filter, .dataTables_wrapper .dataTables_info, .dataTables_wrapper .dataTables_processing, .dataTables_wrapper .dataTables_paginate { + color: var(--md-typeset-color) !important; +} + +.dataTables_wrapper .dataTables_paginate a.paginate_button, .dataTables_wrapper .dataTables_paginate a.paginate_button.current { + color: var(--md-typeset-color) !important; +} + +div.dataTables_info { + margin-top: 0 !important; +} + +div.dt-button-info{ + bottom:0.8rem; + left:1rem; + top:initial; + left:initial; + width:initial; + background-color:#e9ebfc; + border: 1px solid var(--md-typeset-color); + box-shadow:0 0.2rem 0.5rem rgba(0,0,0,.4),0 0 0.05rem rgba(0,0,0,.35); + border-radius:0.1rem; + text-align:left; + color: #2e303e; + min-width:11.1rem; + padding: 0.4rem 0.6rem; + pointer-events: none; + margin:0; +} +div.dt-button-info h2{ + display:none; +} +div.dt-button-info>div{ + padding:2px; + font-size: 18px!important; + color: #2e303e; +} + +table tbody tr:hover { + background-color: rgb(147 147 147 / 10%) !important; + box-shadow: 0 .05rem 0 var(--md-default-bg-color) inset !important; +} + +button.dt-button:hover:not(.disabled), div.dt-button:hover:not(.disabled), a.dt-button:hover:not(.disabled) { + color: #000; +} + +.dataTables_wrapper .dataTables_filter { + float: left !important; + margin-left: 1% !important; +} + +div.dt-buttons { + margin-left: 1% !important; +} + +.dataTables_wrapper .dataTables_filter input { + max-width: 100px !important; +} +@media screen and (max-width: 640px){ + .dataTables_wrapper .dataTables_filter { + float: none !important; + text-align: center !important; + } + + .dataTables_wrapper .dataTables_filter input { + max-width: inherit !important; + } +} + +div.dt-button-collection button.dt-button.active:not(.disabled) { + color: #000 !important; + border: 1px solid #000 !important; +} + +table.NEEDS_DATATABLES, table.NEEDS_TABLE{ + max-width: inherit; + width: inherit; +} + +.md-header__button.md-logo :is(img, png) { + height: 2.2rem !important; +} + +@media screen and (min-width: 76.1875em){ + .md-nav__current-toc { + display: none!important; + } +} +details.sd-dropdown .sd-summary-up, details.sd-dropdown .sd-summary-down { + display: none; +} \ No newline at end of file diff --git a/docs/ub_theme/js/ub-theme.js b/docs/ub_theme/js/ub-theme.js new file mode 100644 index 0000000..dad2c28 --- /dev/null +++ b/docs/ub_theme/js/ub-theme.js @@ -0,0 +1,3 @@ +$(document).ready(function() { + $("table.NEEDS_DATATABLES, table.NEEDS_TABLE").wrap("
"); +}); \ No newline at end of file diff --git a/docs/ub_theme/templates/layout.html b/docs/ub_theme/templates/layout.html new file mode 100644 index 0000000..60f547b --- /dev/null +++ b/docs/ub_theme/templates/layout.html @@ -0,0 +1,6 @@ +{# Import the theme's layout. #} +{% extends '!layout.html' %} + +{%- block extrahead %} + {{ super() }} +{%- endblock %} diff --git a/docs/ub_theme/templates/partials/copyright.html b/docs/ub_theme/templates/partials/copyright.html new file mode 100644 index 0000000..7b50ba2 --- /dev/null +++ b/docs/ub_theme/templates/partials/copyright.html @@ -0,0 +1,24 @@ +{#- + This file was automatically generated - do not edit +-#} +
+ {% if show_copyright %} +
+ {%- if hasdoc('copyright') %} + {% trans path=pathto('copyright'), copyright=copyright|e %}© + Copyright {{ copyright }}. + {% endtrans %} + {%- else %} +

Sponsored and maintained with 💛 by + {% trans copyright=copyright|e %} + © {{ copyright }} + {% endtrans %} +

+ {%- endif %} +
+ {% endif %} + {%- if show_sphinx %} + {%- endif %} + {{ rendered_extracopyright }} +
+ From e05825ff426ccfa9e23d07a3ed5b76def8f2bea6 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Mon, 23 Jan 2023 04:19:22 +0000 Subject: [PATCH 10/14] Updated README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 94210cf..91e0c47 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ To install the files from this repository, you must have [Git](https://git-scm.c ``` * Download the files from the repository: ```bash - git clone https://github.com/useblocks/useblocks-theme.git + git clone https://github.com/useblocks/ub_theme.git ``` * Delete both the **.git** hidden directory and **.gitignore** hidden file from the **ub_theme** folder. @@ -31,12 +31,12 @@ You must configure the following in the **conf.py** file of the Sphinx documenta import sys sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file ``` -* Add the `html_theme_options` to your **conf.py**: +* Add the `ub_html_theme_options` to your **conf.py**: * Import the theme options for Useblocks. ```python from ub_theme.conf import ub_html_theme_options ``` - * Set it as the value for the `html_theme_options` variable. + * Set it as the value for the `ub_html_theme_options` variable. ```python html_theme_options = ub_html_theme_options ``` @@ -83,7 +83,7 @@ html_theme_options = ub_html_theme_options # You can add other Sphinx-Immaterial theme options like below other_options = { - "repo_url": "https://github.com/useblocks/useblocks-theme", + "repo_url": "https://github.com/useblocks/ub_theme", "repo_name": "useblocks-theme", "repo_type": "github", } From fa8d5a7f8d73c5682c43af1c1508d8688358487f Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Mon, 6 Feb 2023 17:11:58 +0000 Subject: [PATCH 11/14] Updated text font to Recursive --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 04db69d..7946575 100644 --- a/conf.py +++ b/conf.py @@ -4,7 +4,7 @@ }, "font": { "code": "JetBrains Mono", - "text": "Urbanist" + "text": "Recursive" }, "globaltoc_collapse": True, "features": [ From 265c53dbf3b17abcdd52dae71f85bae5d0ddbf26 Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Thu, 9 Feb 2023 05:24:00 +0000 Subject: [PATCH 12/14] Delete ub-theme folder added manually --- docs/ub_theme/README.md | 102 -------- docs/ub_theme/__init__.py | 0 docs/ub_theme/conf.py | 41 ---- docs/ub_theme/css/ub-theme.css | 229 ------------------ docs/ub_theme/js/ub-theme.js | 3 - docs/ub_theme/templates/layout.html | 6 - .../templates/partials/copyright.html | 24 -- 7 files changed, 405 deletions(-) delete mode 100644 docs/ub_theme/README.md delete mode 100644 docs/ub_theme/__init__.py delete mode 100644 docs/ub_theme/conf.py delete mode 100644 docs/ub_theme/css/ub-theme.css delete mode 100644 docs/ub_theme/js/ub-theme.js delete mode 100644 docs/ub_theme/templates/layout.html delete mode 100644 docs/ub_theme/templates/partials/copyright.html diff --git a/docs/ub_theme/README.md b/docs/ub_theme/README.md deleted file mode 100644 index 94210cf..0000000 --- a/docs/ub_theme/README.md +++ /dev/null @@ -1,102 +0,0 @@ -# useblocks-theme -This repository contains the theme for all Useblock documentation sites. - -> **NOTE:** -> - Useblocks uses the Sphinx-Immaterial theme so ensure that the theme is already installed and applied. -> - Install `sphinx_immaterial` by running this command: `pip install sphinx-immaterial`. -> - Then activate the theme by adding it to the `extension` variable under **conf.py**: `extensions = ["sphinx_immaterial"]` -> - And change the `html_theme` variable to `html_theme = "sphinx_immaterial"` - -## Installation -To install the files from this repository, you must have [Git](https://git-scm.com) installed. - -* Change directory to your preferred docs working directory - ```bash - cd docs - ``` -* Download the files from the repository: - ```bash - git clone https://github.com/useblocks/useblocks-theme.git - ``` -* Delete both the **.git** hidden directory and **.gitignore** hidden file from the **ub_theme** folder. - -## Configuration - -You must configure the following in the **conf.py** file of the Sphinx documentation project. - -* In order to import the **ub_theme** package, Python searches through the directories on `sys.path` looking for the package subdirectory. - * Add the parent path of the **ub_theme** folder to `sys.path`. - ```python - import os - import sys - sys.path.append(os.path.abspath(".")) # Example if `ub_theme` folder is in the same folder as the `conf.py` file - ``` -* Add the `html_theme_options` to your **conf.py**: - * Import the theme options for Useblocks. - ```python - from ub_theme.conf import ub_html_theme_options - ``` - * Set it as the value for the `html_theme_options` variable. - ```python - html_theme_options = ub_html_theme_options - ``` -* Add the custom template changes folder to the `templates_path` variable. - ```python - templates_path = ["_templates", "ub_theme/templates"] - ``` -* Add custom CSS changes: - * Add the folder containing the CSS files to the `html_static_path` variable. - ```python - html_static_path = ["ub_theme/css"] - ``` - * Add the custom CSS files to the `html_css_files` variable. - ```python - html_css_files = ["ub-theme.css"] - ``` -* Add custom JS changes: - * Add the folder containing the JS files to the `html_static_path` variable. - ```python - html_static_path = ["ub_theme/js"] - ``` - * Add the custom JS files to the `html_js_files` variable. - ```python - html_js_files = ["ub-theme.js"] - ``` - -The final configuration should look like below: -```python -import os -import sys - -sys.path.append(os.path.abspath(".")) - -from ub_theme.conf import ub_html_theme_options - -extensions = [ - "sphinx_immaterial", -] - -templates_path = ["_templates", "ub_theme/templates"] - -html_theme = "sphinx_immaterial" -html_theme_options = ub_html_theme_options - -# You can add other Sphinx-Immaterial theme options like below -other_options = { - "repo_url": "https://github.com/useblocks/useblocks-theme", - "repo_name": "useblocks-theme", - "repo_type": "github", -} -html_theme_options.update(other_options) - -html_static_path = ["_static", "ub_theme/css", "ub_theme/js"] -html_css_files = ["ub-theme.css"] -html_js_files = ["ub-theme.js"] - -``` - -## Changelog - -* 23.01.2023 - Updated CSS for theme, changelog and conf.py -* 13.01.2023 - Updated CSS stylesheets and docs on how to apply the theme customization. -* 28.12.2022 - Setup and added the initial Useblocks theme codes. diff --git a/docs/ub_theme/__init__.py b/docs/ub_theme/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/docs/ub_theme/conf.py b/docs/ub_theme/conf.py deleted file mode 100644 index 04db69d..0000000 --- a/docs/ub_theme/conf.py +++ /dev/null @@ -1,41 +0,0 @@ -ub_html_theme_options = { - "icon": { - "repo": "fontawesome/brands/github", - }, - "font": { - "code": "JetBrains Mono", - "text": "Urbanist" - }, - "globaltoc_collapse": True, - "features": [ - "navigation.top", - "search.share", - "navigation.tracking", - "toc.follow", - "content.tabs.link" - ], - "palette": [ - { - "media": "(prefers-color-scheme: light)", - "scheme": "default", - "primary": "yellow", - "accent": "yellow", - "toggle": { - "icon": "material/weather-night", - "name": "Switch to dark mode", - }, - }, - { - "media": "(prefers-color-scheme: dark)", - "scheme": "slate", - "primary": "yellow", - "accent": "yellow", - "toggle": { - "icon": "material/weather-sunny", - "name": "Switch to light mode", - }, - }, - ], - "toc_title_is_page_title": True, - "toc_title": "Contents", -} diff --git a/docs/ub_theme/css/ub-theme.css b/docs/ub_theme/css/ub-theme.css deleted file mode 100644 index 53b1d1f..0000000 --- a/docs/ub_theme/css/ub-theme.css +++ /dev/null @@ -1,229 +0,0 @@ -/* @import url('https://fonts.googleapis.com/css2?family=Recursive:wght@300;400&display=swap'); */ - -:root > * { - --md-primary-fg-color: #FFCC00; - --md-primary-fg-color--light: #ffeb9b; - --md-primary-fg-color--dark: #957700; -} - -/* Nav */ -.md-tabs { - background-color: #000; - color: #fff; - text-align: center; -} -.md-tabs__item span { - font-size: medium; - font-weight: 600; -} -.md-header { - background-color: var(--md-primary-fg-color); - color: #000; -} -.md-top { - top: 70px!important; -} - -/*Light Mode*/ -[data-md-color-scheme=default]{ ---md-default-fg-color--light: #0000008a; ---img-filter: none; -} - -/*Night Mode*/ -[data-md-color-scheme=slate]{ ---md-default-fg-color--light: #d2d7f9; ---img-filter: brightness(0) invert(1); -} -.md-typeset h1{ - color: var(--md-default-fg-color--light); -} - -td.needs_title { - font-weight: bold; -} -.md-typeset pre, pre { - overflow-x: auto; -} -div.wy-table-responsive{ - width: 100% !important; -} -.underline{ - text-decoration: underline; -} -figure[id^="needflow-"] { - overflow-x: auto; -} - - -/*Remove READTHEDOCS version badge*/ -.injected { - display: none !important; -} -div.need_container { - overflow-x: auto; -} -table.need, .md-typeset table.data:not(.plain) { - display: table !important; - width: 100% !important; -} -table { - border: 1px solid #e1e4e5 !important; -} -tbody tr td { - font-size: medium !important; -} -img.needs_image, img.sn_collapse_img { - filter: var(--img-filter); -} - -/* Sphinx-Immaterial */ - -body, -input { - font-size: 18px !important; - font-weight: 400; - line-height: 1.5 !important; -} - -.md-typeset, .md-nav, .md-typeset table:not([class]), - .md-typeset table.data:not(.plain){ - font-size: 18px !important; - line-height: 1.5 !important; -} - -.md-typeset :is(.admonition,details) { - font-size: 14px; -} - -h1, h2, h3 { - font-weight: 500 !important; - line-height: 1.4 !important; -} - -h1:not([class="md-search-result__title"]) { - font-size: 34px !important; - margin-bottom: 20px !important; -} - -h2 { - font-size: 28px !important; - margin-bottom: 10px !important; -} - -h3 { - font-size: 24px !important; - margin-bottom: 10px !important; -} - -/* datatables */ -.dataTables_filter input { - border: 1px solid var(--md-typeset-color); - margin-bottom: 10px; - background-color: transparent; -} - -.border { - border: 1px solid var(--md-typeset-color); -} - -table.dataTable tbody tr { - background-color: transparent; -} -/* -table.dataTable tbody tr { - background-color: transparent !important; -} -*/ -.dataTables_wrapper .dataTables_length, .dataTables_wrapper .dataTables_filter, .dataTables_wrapper .dataTables_info, .dataTables_wrapper .dataTables_processing, .dataTables_wrapper .dataTables_paginate { - color: var(--md-typeset-color) !important; -} - -.dataTables_wrapper .dataTables_paginate a.paginate_button, .dataTables_wrapper .dataTables_paginate a.paginate_button.current { - color: var(--md-typeset-color) !important; -} - -div.dataTables_info { - margin-top: 0 !important; -} - -div.dt-button-info{ - bottom:0.8rem; - left:1rem; - top:initial; - left:initial; - width:initial; - background-color:#e9ebfc; - border: 1px solid var(--md-typeset-color); - box-shadow:0 0.2rem 0.5rem rgba(0,0,0,.4),0 0 0.05rem rgba(0,0,0,.35); - border-radius:0.1rem; - text-align:left; - color: #2e303e; - min-width:11.1rem; - padding: 0.4rem 0.6rem; - pointer-events: none; - margin:0; -} -div.dt-button-info h2{ - display:none; -} -div.dt-button-info>div{ - padding:2px; - font-size: 18px!important; - color: #2e303e; -} - -table tbody tr:hover { - background-color: rgb(147 147 147 / 10%) !important; - box-shadow: 0 .05rem 0 var(--md-default-bg-color) inset !important; -} - -button.dt-button:hover:not(.disabled), div.dt-button:hover:not(.disabled), a.dt-button:hover:not(.disabled) { - color: #000; -} - -.dataTables_wrapper .dataTables_filter { - float: left !important; - margin-left: 1% !important; -} - -div.dt-buttons { - margin-left: 1% !important; -} - -.dataTables_wrapper .dataTables_filter input { - max-width: 100px !important; -} -@media screen and (max-width: 640px){ - .dataTables_wrapper .dataTables_filter { - float: none !important; - text-align: center !important; - } - - .dataTables_wrapper .dataTables_filter input { - max-width: inherit !important; - } -} - -div.dt-button-collection button.dt-button.active:not(.disabled) { - color: #000 !important; - border: 1px solid #000 !important; -} - -table.NEEDS_DATATABLES, table.NEEDS_TABLE{ - max-width: inherit; - width: inherit; -} - -.md-header__button.md-logo :is(img, png) { - height: 2.2rem !important; -} - -@media screen and (min-width: 76.1875em){ - .md-nav__current-toc { - display: none!important; - } -} -details.sd-dropdown .sd-summary-up, details.sd-dropdown .sd-summary-down { - display: none; -} \ No newline at end of file diff --git a/docs/ub_theme/js/ub-theme.js b/docs/ub_theme/js/ub-theme.js deleted file mode 100644 index dad2c28..0000000 --- a/docs/ub_theme/js/ub-theme.js +++ /dev/null @@ -1,3 +0,0 @@ -$(document).ready(function() { - $("table.NEEDS_DATATABLES, table.NEEDS_TABLE").wrap("
"); -}); \ No newline at end of file diff --git a/docs/ub_theme/templates/layout.html b/docs/ub_theme/templates/layout.html deleted file mode 100644 index 60f547b..0000000 --- a/docs/ub_theme/templates/layout.html +++ /dev/null @@ -1,6 +0,0 @@ -{# Import the theme's layout. #} -{% extends '!layout.html' %} - -{%- block extrahead %} - {{ super() }} -{%- endblock %} diff --git a/docs/ub_theme/templates/partials/copyright.html b/docs/ub_theme/templates/partials/copyright.html deleted file mode 100644 index 7b50ba2..0000000 --- a/docs/ub_theme/templates/partials/copyright.html +++ /dev/null @@ -1,24 +0,0 @@ -{#- - This file was automatically generated - do not edit --#} -
- {% if show_copyright %} -
- {%- if hasdoc('copyright') %} - {% trans path=pathto('copyright'), copyright=copyright|e %}© - Copyright {{ copyright }}. - {% endtrans %} - {%- else %} -

Sponsored and maintained with 💛 by - {% trans copyright=copyright|e %} - © {{ copyright }} - {% endtrans %} -

- {%- endif %} -
- {% endif %} - {%- if show_sphinx %} - {%- endif %} - {{ rendered_extracopyright }} -
- From 9d61e19ac18df06f6d3958944536093e880a83fe Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Thu, 9 Feb 2023 05:40:29 +0000 Subject: [PATCH 13/14] Updated conf.py and doc-requirements.txt --- docs/conf.py | 2 +- docs/doc-requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1591fa6..95b94b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ extensions = [ 'sphinx_simplepdf', 'sphinxcontrib.plantuml', - 'sphinxcontrib.needs', + 'sphinx_needs', 'sphinx_immaterial', 'sphinx_copybutton', ] diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index 3906271..e539864 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,5 +1,5 @@ sphinx==5.1.1 sphinxcontrib-plantuml==0.24 -sphinxcontrib-needs==0.7.8 +sphinx-needs>=1.1.1 sphinx-copybutton sphinx-immaterial \ No newline at end of file From 1773633207107db2c588ee2528e3ea68a5bd4f1f Mon Sep 17 00:00:00 2001 From: "Randy Duodu (He/Him)" Date: Thu, 9 Feb 2023 05:51:12 +0000 Subject: [PATCH 14/14] Updated doc-requirements.txt --- demo/doc-requirements.txt | 2 +- docs/doc-requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/demo/doc-requirements.txt b/demo/doc-requirements.txt index df198c4..ad7fa5b 100644 --- a/demo/doc-requirements.txt +++ b/demo/doc-requirements.txt @@ -1,3 +1,3 @@ sphinx==5.1.1 sphinxcontrib-plantuml==0.24 -sphinx-needs==1.0.2 +sphinx-needs diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index e539864..395c9ba 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,5 +1,5 @@ sphinx==5.1.1 sphinxcontrib-plantuml==0.24 -sphinx-needs>=1.1.1 +sphinx-needs sphinx-copybutton sphinx-immaterial \ No newline at end of file