[24] move to mkdocs

.readthedocs.yml

@@ -5,10 +5,10 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.7"
+    python: "3.11"
 
-sphinx:
+mkdocs:
-  configuration: docs/conf.py
+  configuration: mkdocs.yml
 
 formats: []
 

VERSION

@@ -1 +1 @@
-1.19.1-develop23
+1.19.1-develop24

docs/.meta.yml

@@ -0,0 +1 @@
+ᴴₒᴴₒᴴₒ: false

docs/404.md

@@ -1,6 +0,0 @@
-<center><h1>This is not the page you're looking for.</h1></center>
-
-```{image} 404.gif
-:alt: 
-:align: center
-```

docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

@@ -1,560 +0,0 @@
-body {
-  font-size: 18px;
-  color: #dfe1f2;
-  background-color: #252525;
-}
-
-div.body {
-  max-width: 1000px;
-}
-
-pre {
-    background-color: #0d0d0d;
-    color: #a9abba;
-    box-shadow: none;
-    display: block;
-    border-color: transparent;
-}
-
-ul, ol {
-    font-size: 17x;
-}
-
-ol.arabic {
-    list-style: decimal;
-    font-size: 17px;
-}
-
-ul .simple {
-    font-size: 17px;
-}
-
-.highlight .nt {
-  color: #a9abba;
-  font-weight: bold;
-}
-
-.highlight .nl {
-    color: #f57900;
-}
-
-.highlight .c1 {
-    color: #157059;
-}
-
-.highlight .l {
-  color: #0ce3ac;
-}
-
-.highlight .s {
-    color: #0ce3ac;
-}
-
-.highlight .no {
-    color: #a9abba;
-}
-
-.highlight .k {
-    color: #a9abba;
-    font-weight: bold;
-}
-
-.highlight .mi {
-    color: #a9abba;
-    font-weight: bold;
-}
-
-.highlight .ow {
-    color: #a9abba;
-    font-weight: bold;
-}
-
-.highlight .s1 {
-    color: #0ce3ac;
-}
-
-.highlight .kn {
-    color: #a9abba;
-    font-weight: bold;
-}
-
-.highlight .nn {
-    color: #a9abba;
-}
-.highlight .nl {
-    color: #0ce3ac;
-    font-weight: bold;
-}
-
-.highlight .p {
-  color: #a9abba;
-  font-weight: bold;
-}
-
-.highlight .n {
-  color: #a9abba;
-}
-
-.highlight .nv {
-  color: #a9abba;
-}
-
-.highlight .nb {
-    color: #a9abba;
-}
-.highlight .kt {
-    color: #0ce3ac;
-    font-weight: bold;
-}
-
-.highlight .mf {
-    color: #a9abba;
-}
-
-.highlight .o {
-  color: #a9abba;
-  font-weight: bold;
-}
-
-.highlight .s2 {
-    color: #0ce3ac;
-}
-
-.tab-set > label {
-  font-size: 0.75em;
-}
-
-label {
-  margin-bottom: 0px;
-}
-
-button.copybtn {
-    position: absolute;
-    display: flex;
-    top: .3em;
-    right: .3em;
-    width: 1.7em;
-    height: 1.7em;
-	opacity: 100;
-    transition: opacity 0.3s, border .3s, background-color .3s;
-    user-select: none;
-    padding: 0;
-    border: none;
-    outline: none;
-    border-radius: 0.4em;
-    /* The colors that GitHub uses */
-    border: transparent 1px solid;
-    background-color: transparent;
-    color: #57606a;
-}
-.highlight button.copybtn:hover {
-    background-color: transparent;
-}
-
-.highlight button.copybtn:active {
-    background-color: transparent;
-}
-button.copybtn.success {
-    border-color: transparent;
-    color: #22863a;
-}
-button.copybtn svg {
-    stroke: #a9abba;
-    width: 1.5em;
-    height: 1.5em;
-    padding: 0em;
-}
-.tab-set {
-  width: auto !important;
-  border-style: solid;
-  border-width: 1px;
-  border-color: #00bfa5;
-  box-shadow: 0px 3px #282829
-  background-color: #293e49;
-  border-radius: 5px;
-  background-color: #293e49;
-}
-
-.tab-content {
-  box-shadow: 0 -0.1rem #0ce3ac;
-  background-color: #252525;
-  padding-top: 0px;
-  padding-right: 15px;
-  padding-left: 15px;
-  font-size: 15px;
-}
-
-details {
-  border-style: solid;
-  border-width: 1px;
-  border-color: #00b8d4;
-  box-shadow: 0px 3px #282829;
-  border-radius: 5px;
-}
-details.details-tabs > div {
-  margin: 0;
-}
-details.details-tabs[open] > summary {
-  margin: 0;
-}
-details[open] > summary {
-  margin: 0 0 10px 0;
-}
-details > :not(summary) {
-  padding: 0 10px 0 10px;
-}
-details > ul, details > ol {
-  margin-left: 20px;
-  margin-right: 20px;
-}
-.table {
-  width: auto;
-  max-width: 100%;
-  margin-bottom: 21px;
-  background: #transparent;
-  border-collapse: collapse;
-  font-size: 17px
-}
-
-table thead tr {
-  background-color: #151515;
-}
-
-:root {
-  --tabs--label-text: #FFFFFF;
-  --tabs--label-text--hover: #0ce3ac;
-  --tabs--label-text--active: #0ea5e9;
-  --tabs--label-text--active--hover: #0ea5e9;
-  --tabs--label-background: transparent;
-  --tabs--label-background--hover: transparent;
-  --tabs--label-background--active: transparent;
-  --tabs--label-background--active--hover: transparent;
-  --tabs--label-border: transparent;
-  --tabs--label-border--hover: #d1d5db;
-  --tabs--label-border--active: #0ea5e9;
-  --tabs--label-border--active--hover: #0ea5e9;
-  --tabs--padding-x: 1.25em;
-  --tabs--margin-x: 0;
-  --tabs--border: #e6e6e6;
-}
-
-.text-left {
-  text-align: left !important;
-  padding-left: 15px !important;
-}
-.text-center {
-  text-align: center !important;
-}
-.text-right {
-  text-align: right !important;
-}
-.caption {
-  margin: 15px 0 5px 10px;
-}
-code {
-  color: #a9abba;
-  background-color: #0d0d0d !important;
-}
-td hr, th hr {
-    visibility: hidden;
-    margin: 0;
-}
-table.align-default {
-    margin-left: inherit;
-}
-hr {
-  border-top: 3px solid #bcbcbc;
-  margin-top: 50px;
-  margin-bottom: 30px;
-}
-pre code {
-  background-color: #bcbcbc;
-}
-a code {
-  color: #0cafe3;
-}
-a {
-  color: #09a77e;
-}
-a:hover {
-  color: #0ce3ac; !important;
-}
-a code {
-  color: #09a77e;
-}
-h1, .h1, {
-  margin: 0 0 1.25em;
-}
-h2, .h2, {
-  margin: 1.6em 0 .64em;
-}
-h3, .h3, {
-  margin: 1.6em 0 .8em;
-}
-h4, .h4, {
-  margin: 1em 0;
-
-}
-
-h5., h6, .h5, .h6 {
-  margin: 1.25em 0
-}
-
-h1, .h1 {
-  color: #4aedc4;
-}
-
-h2, h3, h4, h5, h6, .h2, .h3, .h4, .h5, .h6 {
-  color: #0ce3ac;
-}
-
-th {
-  color: #0ce3ac;
-}
-.dropdown-submenu {
-  position: relative;
-}
-
-.dropdown-submenu>.dropdown-menu {
-  top: 0;
-  left: 100%;
-  margin-top: -6px;
-  margin-left: -1px;
-  -webkit-border-radius: 0 6px 6px 6px;
-  -moz-border-radius: 0 6px 6px;
-  border-radius: 0 6px 6px 6px;
-}
-
-.dropdown-submenu:hover>.dropdown-menu {
-  display: block;
-}
-
-.dropdown-submenu>a:after {
-  display: block;
-  content: " ";
-  float: right;
-  width: 0;
-  height: 0;
-  border-color: transparent;
-  border-style: solid;
-  border-width: 5px 0 5px 5px;
-  border-left-color: #ccc;
-  margin-top: 5px;
-  margin-right: -10px;
-}
-
-.dropdown-submenu:hover>a:after {
-  border-left-color: #fff;
-}
-
-.dropdown-submenu.pull-left {
-  float: none;
-}
-.dropdown-submenu.pull-left>.dropdown-menu {
-  left: -100%;
-  margin-left: 10px;
-  -webkit-border-radius: 6px 0 6px 6px;
-  -moz-border-radius: 6px 0 6px 6px;
-  border-radius: 6px 0 6px 6px;
-}
-table tbody tr:nth-child(even) {
-  background-color: #181818;
-}
-table tbody tr:nth-child(odd) {
-  background-color: #1D1D1D;
-}
-table.clearTable {
-  margin-top: 5px;
-  margin-bottom: 5px;
-}
-table.clearTable td {
-  padding: 3px 3px 3px 15px;
-}
-table.clearTable th {
-  text-align: center;
-}
-table.clearTable, table.clearTable tbody, table.clearTable tr, table.clearTable td, table.clearTable th {
-  background-color: rgba(0, 0, 0, 0.0) !important;
-}
-table.dualTable td, table.dualTable th {
-  padding-left: 15px !important;
-}
-.images-index-table {
-    padding: 0;
-}
-.images-index-table li {
-    display: inline-block;
-}
-.images-inline-link {
-    padding: 8px 10px;
-    display: inline-block;
-    background-color: #181818;
-    border-radius: 10px;
-    margin: 0 5px 5px 0;
-    text-align: center;
-    line-height: 20px;
-}
-.images-inline-link code {
-    font-size: 60%;
-}
-.image-accordion {
-    border-radius: 15px;
-    background-color: #1D1D1D;
-    color: #0ce3ac;
-    cursor: pointer;
-    padding: 18px;
-    width: 100%;
-    border: none;
-    text-align: left;
-    outline: none;
-    font-size: 20px;
-    transition: 0.4s;
-    margin: 5px 0 0 0;
-}
-.image-active {
-    border-radius: 15px 15px 0 0 !important;
-    background-color: #181818;
-}
-.image-accordion:hover {
-    background-color: #181818;
-}
-.image-panel {
-  background-color: #181818;
-  max-height: 0;
-  overflow: auto hidden;
-  border-radius: 0 0 15px 15px;
-  transition: max-height 0.2s ease-out;
-  padding-left: 10px;
-  padding-right: 10px;
-}
-.image-accordion:after {
-  content: '\25BC';
-  font-size: 13px;
-  color: #777;
-  float: right;
-  margin-left: 5px;
-}
-.image-active:after {
-  content: "\25B2";
-}
-table.image-table {
-  /* margin: 0 auto; */
-  border-collapse: separate;
-}
-table.image-table div {
-    margin: 0 10px 0 0;
-    border-radius: 15px;
-    padding: 10px 10px 0 10px;
-    text-align: center;
-    background-color: #1D1D1D;
-    line-height: 15px;
-}
-table.image-table td:last-child div {
-    margin: 0;
-}
-table.image-table, table.image-table tbody, table.image-table tr, table.image-table th {
-  background-color: rgba(0, 0, 0, 0.0) !important;
-}
-table.image-table img {
-  border-radius: 15px;
-  margin: 0 0 15px 0;
-}
-details {
-  margin-bottom: 5px;
-  border-color: #7c4dff;
-}
-summary {
-  padding: 6px 12px 6px 22px;
-  background: #363352;
-  position: relative;
-  cursor: pointer;
-}
-summary:before {
-  content: '';
-  border-width: .4rem;
-  border-style: solid;
-  border-color: transparent transparent transparent #fff;
-  position: absolute;
-  top: 1.3rem;
-  left: 1rem;
-  transform: rotate(0);
-  transform-origin: .2rem 50%;
-  transition: .25s transform ease;
-}
-details[open] > summary:before {
-  transform: rotate(90deg);
-}
-details summary::-webkit-details-marker {
-  display:none;
-}
-
-td br {
-  margin-bottom: 15px;
-}
-td p {
-  margin-bottom: 0 !important;
-}
-p {
-  -moz-hyphens: none !important;
-  -ms-hyphens: none !important;
-  -webkit-hyphens: none !important;
-  hyphens: none !important;
-}
-.dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus {
-  background-color: #00a379 !important;
-}
-.navbar-inverse .navbar-brand:hover, .navbar-inverse .navbar-brand:focus, .navbar-inverse .navbar-nav > li > a:hover, .navbar-inverse .navbar-nav > li > a:focus {
-  color: #222222 !important;
-}
-.tab-set {
-  width: auto !important;
-}
-.highlighted {
-  background-color: #ac0ce3 !important;
-  color: #FFFFFF !important;
-}
-a .logo {
-   display: block;
-}
-a:hover .logo {
-   display: none;
-}
-a .logo-hover {
-   display: none;
-}
-a:hover .logo-hover {
-   display: block;
-}
-.tab-content {
-  box-shadow: 0 -0.1rem #0ce3ac;
-  padding-top: 10px;
-  padding-bottom: 10px;
-}
-.tab-set > label {
-}
-.tab-set > input:checked + label:hover {
-}
-.tab-set > input:checked + label {
-    color: #0ce3ac !important;
-    border-color: #0ce3ac !important;
-}
-/* Responsive YT Video Embedding */
-.responsiveYT {
-    position: relative;
-    height: 0;
-    padding-top: 56%;
-    overflow: hidden;
-    max-width: 100%;
-}
-.responsiveYT iframe,
-.responsiveYT object,
-.responsiveYT embed {
-    position: absolute;
-    top: 0;
-    left: 0;
-    width: 100%;
-    height: 100%;
-}
-.responsiveYT .fluid-vids {
-    position: initial !important
-}

docs/_templates/navbar.html

@@ -1,105 +0,0 @@
-  <div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top|tobool -%} navbar-fixed-top{%- endif -%}">
-    <div class="container">
-      <div class="navbar-header">
-        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-        </button>
-        <a class="navbar-brand" href="{{ pathto(master_doc) }}" style="padding: 12px;">
-          {%- block sidebarlogo %}
-            {%- if logo %}
-              <span>
-                <img src="{{ pathto('_static/' + logo, 1) }}" class="logo">
-                <img src="{{ pathto('_static/alt-' + logo, 1) }}" class="logo-hover">
-              </span>
-            {%- endif %}
-          {%- endblock %}
-        </a>
-      </div>
-
-        <div class="collapse navbar-collapse nav-collapse">
-          <ul class="nav navbar-nav">
-            {% if theme_navbar_links %}
-              {%- for menu in theme_navbar_links %}
-                {% if menu[0] == "_menu" %}
-                  <li class="dropdown">
-                    <a role="button" id="{{ menu[1] }}Toc" data-toggle="dropdown" data-target="#" href="#" aria-expanded="false">{{ menu[1] }} <b class="caret"></b></a>
-                    <ul class="dropdown-menu multi-level" role="menu" aria-labelledby="{{ menu[1] }}Toc">
-                    {%- for link in menu[2] %}
-                      {% if link[0] == "_divider" %}
-                        <li class="divider"></li>
-                      {% elif link[0] == "_menu" %}
-                        <li class="dropdown-submenu">
-                          {% if link|length == 4 %}
-                            <a tabindex="-1" href="{{ pathto(link[2]) }}">{{ link[1] }}</a>
-                          {% elif link|length == 5 %}
-                            <a tabindex="-1" href="{{ pathto(link[2]) }}{{ link[3] }}">{{ link[1] }}</a>
-                          {% else %}
-                            <a tabindex="-1" href="#">{{ link[1] }}</a>
-                          {% endif %}
-                          <ul class="dropdown-menu">
-                            {%- for sublink in link[-1] %}
-                              {% if sublink[0] == "_divider" %}
-                                <li class="divider"></li>
-                              {% elif sublink[0] == "_menu" %}
-                                <li class="dropdown-submenu">
-                                  {% if sublink|length == 4 %}
-                                    <a tabindex="-1" href="{{ pathto(sublink[2]) }}">{{ sublink[1] }}</a>
-                                  {% elif sublink|length == 5 %}
-                                    <a tabindex="-1" href="{{ pathto(sublink[2]) }}{{ sublink[3] }}">{{ sublink[1] }}</a>
-                                  {% else %}
-                                    <a tabindex="-1" href="#">{{ sublink[1] }}</a>
-                                  {% endif %}
-                                  <ul class="dropdown-menu">
-                                    {%- for specificlink in sublink[-1] %}
-                                      {% if specificlink[0] == "_divider" %}
-                                        <li class="divider"></li>
-                                      {% elif specificlink|length > 2 %}
-                                        <li><a href="{{ pathto(specificlink[1]) }}{{ specificlink[2] }}">{{ specificlink[0] }}</a></li>
-                                      {% else %}
-                                        <li><a href="{{ specificlink[1] if specificlink[1][:4] == 'http' else pathto(specificlink[1]) }}">{{ specificlink[0] }}</a></li>
-                                      {% endif %}
-                                    {%- endfor %}
-                                  </ul>
-                                </li>
-                              {% elif sublink|length > 2 %}
-                                <li><a href="{{ pathto(sublink[1]) }}{{ sublink[2] }}">{{ sublink[0] }}</a></li>
-                              {% else %}
-                                <li><a href="{{ sublink[1] if sublink[1][:4] == 'http' else pathto(sublink[1]) }}">{{ sublink[0] }}</a></li>
-                              {% endif %}
-                            {%- endfor %}
-                          </ul>
-                        </li>
-                      {% elif link|length > 2 %}
-                        <li><a href="{{ pathto(link[1]) }}{{ link[2] }}">{{ link[0] }}</a></li>
-                      {% else %}
-                        <li><a href="{{ link[1] if link[1][:4] == 'http' else pathto(link[1]) }}">{{ link[0] }}</a></li>
-                      {% endif %}
-                    {%- endfor %}
-                    </ul>
-                  </li>
-                {% else %}
-                  <li><a href="{{ pathto(*menu[1:]) }}">{{ menu[0] }}</a></li>
-                {% endif %}
-              {%- endfor %}
-            {% endif %}
-            {% if theme_navbar_sidebarrel %}
-              {% block sidebarrel %}
-                {% include "relations.html" %}
-              {% endblock %}
-            {% endif %}
-            {% block navbarextra %}
-            {% endblock %}
-            {% if theme_source_link_position == "nav" %}
-              <li class="hidden-sm">{% include "sourcelink.html" %}</li>
-            {% endif %}
-          </ul>
-
-          {% block navbarsearch %}
-            {% include "navbarsearchbox.html" %}
-          {% endblock %}
-        </div>
-    </div>
-  </div>