properdocs-theme-mkdocs 1.6.5__py3-none-any.whl

properdocs_theme_mkdocs/js/darkmode.js

@@ -0,0 +1,65 @@
+function setColorMode(mode) {
+    // Switch between light/dark theme. `mode` is a string value of either 'dark' or 'light'.
+    var hljs_light = document.getElementById('hljs-light'),
+        hljs_dark = document.getElementById('hljs-dark');
+    document.documentElement.setAttribute('data-bs-theme', mode);
+    if (mode == 'dark') {
+        hljs_light.disabled = true;
+        hljs_dark.disabled = false;
+    } else {
+        hljs_dark.disabled = true;
+        hljs_light.disabled = false;
+    }
+}
+
+function updateModeToggle(mode) {
+    // Update icon and toggle checkmarks of color mode selector.
+    var menu = document.getElementById('theme-menu');
+    document.querySelectorAll('[data-bs-theme-value]')
+       .forEach(function(toggle) {
+            if (mode == toggle.getAttribute('data-bs-theme-value')) {
+                toggle.setAttribute('aria-pressed', 'true');
+                toggle.lastElementChild.classList.remove('d-none');
+                menu.firstElementChild.setAttribute('class', toggle.firstElementChild.getAttribute('class'));
+            } else {
+                toggle.setAttribute('aria-pressed', 'false');
+                toggle.lastElementChild.classList.add('d-none');
+            }
+        });
+}
+
+function onSystemColorSchemeChange(event) {
+    // Update site color mode to match system color mode.
+    setColorMode(event.matches ? 'dark' : 'light');
+}
+
+var mql = window.matchMedia('(prefers-color-scheme: dark)'),
+    defaultMode = document.documentElement.getAttribute('data-bs-theme'),
+    storedMode = localStorage.getItem('mkdocs-colormode');
+if (storedMode && storedMode != 'auto') {
+    setColorMode(storedMode);
+    updateModeToggle(storedMode);
+} else if (storedMode == 'auto' || defaultMode == 'auto') {
+    setColorMode(mql.matches ? 'dark' : 'light');
+    updateModeToggle('auto');
+    mql.addEventListener('change', onSystemColorSchemeChange);
+} else {
+    setColorMode(defaultMode);
+    updateModeToggle(defaultMode);
+}
+
+document.querySelectorAll('[data-bs-theme-value]')
+    .forEach(function(toggle) {
+        toggle.addEventListener('click', function (e) {
+            var mode = e.currentTarget.getAttribute('data-bs-theme-value');
+            localStorage.setItem('mkdocs-colormode', mode);
+            if (mode == 'auto') {
+                setColorMode(mql.matches ? 'dark' : 'light');
+                mql.addEventListener('change', onSystemColorSchemeChange);
+            } else {
+                setColorMode(mode);
+                mql.removeEventListener('change', onSystemColorSchemeChange);
+            }
+            updateModeToggle(mode);
+        });
+    });

properdocs_theme_mkdocs/keyboard-modal.html

@@ -0,0 +1,40 @@
+<div class="modal" id="properdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">{% trans %}Keyboard Shortcuts{% endtrans %}</h4>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="{% trans %}Close{% endtrans %}"></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">{% trans %}Keys{% endtrans %}</th>
+                    <th>{% trans %}Action{% endtrans %}</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>{% trans %}Open this help{% endtrans %}</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>{% trans %}Next page{% endtrans %}</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>{% trans %}Previous page{% endtrans %}</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>{% trans %}Search{% endtrans %}</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>

properdocs_theme_mkdocs/main.html

@@ -0,0 +1,10 @@
+{% extends "base.html" %}
+
+{#
+The entry point for the ProperDocs Theme.
+
+Any theme customisations should override this file to redefine blocks defined in
+the various templates. The custom theme should only need to define a main.html
+which `{% extends "base.html" %}` and defines various blocks which will replace
+the blocks defined in base.html and its included child templates.
+#}

properdocs_theme_mkdocs/mkdocs_theme.yml

@@ -0,0 +1,28 @@
+# Config options for 'mkdocs' theme
+
+static_templates:
+  - 404.html
+
+locale: en
+
+include_search_page: false
+search_index_only: false
+
+highlightjs: true
+hljs_languages: []
+hljs_style: github
+hljs_style_dark: github-dark
+
+navigation_depth: 2
+nav_style: primary
+color_mode: light
+user_color_mode_toggle: false
+
+analytics:
+  gtag: null
+
+shortcuts:
+  help: 191    # ?
+  next: 78     # n
+  previous: 80 # p
+  search: 83   # s

properdocs_theme_mkdocs/nav-sub.html

@@ -0,0 +1,14 @@
+{%- if not nav_item.children %}
+<li>
+    <a href="{{ nav_item.url|url }}" class="dropdown-item{% if nav_item.active %} active" aria-current="page{% endif %}">{{ nav_item.title }}</a>
+</li>
+{%- else %}
+  <li class="dropdown-submenu">
+    <a href="#" class="dropdown-item">{{ nav_item.title }}</a>
+    <ul class="dropdown-menu">
+        {%- for nav_item in nav_item.children %}
+            {% include "nav-sub.html" %}
+        {%- endfor %}
+    </ul>
+  </li>
+{%- endif %}

properdocs_theme_mkdocs/search-modal.html

@@ -0,0 +1,21 @@
+<div class="modal" id="properdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="searchModalLabel">{% trans %}Search{% endtrans %}</h4>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="{% trans %}Close{% endtrans %}"></button>
+            </div>
+            <div class="modal-body">
+                <p>{% trans %}From here you can search these documents. Enter your search terms below.{% endtrans %}</p>
+                <form>
+                    <div class="form-group">
+                        <input type="search" class="form-control" placeholder="{% trans %}Search...{% endtrans %}" id="properdocs-search-query" title="{% trans %}Type search term here{% endtrans %}">
+                    </div>
+                </form>
+                <div id="properdocs-search-results" data-no-results-text="{% trans %}No results found{% endtrans %}"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>

properdocs_theme_mkdocs/toc.html

@@ -0,0 +1,26 @@
+<div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
+    <div class="navbar-header">
+        <button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="{% trans %}Table of Contents{% endtrans %}">
+            <span class="fa fa-angle-down"></span>
+        </button>
+    </div>
+
+    {% macro toc_item(item) %}
+        {%- if item.level <= config.theme.navigation_depth %}
+            <li class="nav-item" data-bs-level="{{ item.level }}"><a href="{{ item.url }}" class="nav-link">{{ item.title }}</a>
+              <ul class="nav flex-column">
+                {%- for child in item.children %}
+                    {{- toc_item(child) }}
+                {%- endfor %}
+              </ul>
+            </li>
+        {%- endif %}
+    {%- endmacro %}
+    <div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
+        <ul class="nav flex-column">
+        {%- for item in page.toc %}
+            {{ toc_item(item) }}
+        {%- endfor %}
+        </ul>
+    </div>
+</div>

properdocs_theme_mkdocs-1.6.5.dist-info/METADATA

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: properdocs-theme-mkdocs
+Version: 1.6.5
+Summary: 'mkdocs' theme for ProperDocs, originally made for MkDocs
+Project-URL: Documentation, https://properdocs.org/
+Project-URL: Source, https://github.com/properdocs/properdocs
+Project-URL: Issues, https://github.com/properdocs/properdocs/issues
+Author-email: Tom Christie <tom@tomchristie.com>
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.9
+Requires-Dist: babel
+Requires-Dist: properdocs
+Description-Content-Type: text/markdown
+
+# properdocs-theme-mkdocs
+
+This package needs to be installed in order to use the "MkDocs" theme with the [ProperDocs](https://properdocs.org/) documentation generator:
+
+    pip install properdocs-theme-mkdocs
+
+(See <https://properdocs.org/dev-guide/themes/>)
+
+It originates as the "MkDocs" theme made for the [MkDocs](https://www.mkdocs.org/) documentation generator.

properdocs_theme_mkdocs-1.6.5.dist-info/RECORD

@@ -0,0 +1,53 @@
+properdocs_theme_mkdocs/404.html,sha256=D6zQ5J04vvm4V58PBOCdCvyCuLcEZ9w7svhEDmRYfTE,332
+properdocs_theme_mkdocs/__init__.py,sha256=3qXyhppw2sa-bg221tzcovcj30gUPxz-RShKQALSueg,22
+properdocs_theme_mkdocs/base.html,sha256=QT1bN6WsMPFJfbA-YZHzPZU_OjeBC1W5-TqkxkxT5LY,14334
+properdocs_theme_mkdocs/content.html,sha256=5y0Am5t8KXfR7lG9eBowCLc-xgXTl6VIpVFLH1VgK_I,204
+properdocs_theme_mkdocs/keyboard-modal.html,sha256=bmHTupRsFfxjmEEryZPJnFXYhRBXWjIeh_waxz5wIs8,1706
+properdocs_theme_mkdocs/main.html,sha256=_wM7kkYf4OFx1nwV_tvTFcJpmZGGFWNllDRyc_4WpQU,382
+properdocs_theme_mkdocs/mkdocs_theme.yml,sha256=56RGtPUc7tiN0yRN5Hn13pwFDkHVu6Qd9MOR7g3ratk,420
+properdocs_theme_mkdocs/nav-sub.html,sha256=8beFqbbCOh4xvMxn340ipPvZ_sRkR7X87vLQzi08Uzc,470
+properdocs_theme_mkdocs/search-modal.html,sha256=A4hK5Yg55hE8OAJHeLjc7RfsrBk_8uyOU0TucaVHlu0,1209
+properdocs_theme_mkdocs/toc.html,sha256=qEFKqBanXlDOGapxqtYKgcVKRGtDJ6nh6jvL-wfiY_4,1077
+properdocs_theme_mkdocs/css/base.css,sha256=j93MkfJ6rulxHauZ3EeO5CRU_ptRJdOTIZMhhhW9rLI,8479
+properdocs_theme_mkdocs/css/bootstrap.min.css,sha256=UWALBbCbbM649IZa_rYTILDmnfc-fXuZQQ2awYBChIs,235601
+properdocs_theme_mkdocs/css/bootstrap.min.css.map,sha256=WLl-J5pJPTsGq5c8azX59LgBjI2KywJCmQcC8HymZwg,88399
+properdocs_theme_mkdocs/css/brands.min.css,sha256=Mh5evqB307O-A_WwIYzqsiWc9ukwNaqGROeXCgVP1oc,19307
+properdocs_theme_mkdocs/css/fontawesome.min.css,sha256=jrW0TOWXGlAeWheVTEZLgKugxGBGdbVgOn9FZFmviKE,80795
+properdocs_theme_mkdocs/css/solid.min.css,sha256=uK-kJD3Rv3NfUScI2lM1sO0xTZ5YoKHPG3gSUM9fsAQ,572
+properdocs_theme_mkdocs/css/v4-font-face.min.css,sha256=hpjrsqMEMwZfMeOSzw5Wp_vpd5jaZzFjYGJCx8qFruY,1736
+properdocs_theme_mkdocs/img/favicon.ico,sha256=8WtFvVP7rKos2PIuhILbXFngzvm9ITlEdKQpoYqY_9A,1150
+properdocs_theme_mkdocs/img/grid.png,sha256=bipYUDSUpwgQWsZG069cCMjIkDJbt4GiV9EPkf-Wipw,1458
+properdocs_theme_mkdocs/js/base.js,sha256=SKhK8FaIQdLaqyV4TOuPdwAa0fj823xa8FMBq2OXWNo,8266
+properdocs_theme_mkdocs/js/bootstrap.bundle.min.js,sha256=gvZPYrsDwbwYJLD5yeBfcNujPhRoGOY831wwbIzz3t0,80663
+properdocs_theme_mkdocs/js/bootstrap.bundle.min.js.map,sha256=GaWwuI0k1rFUxEYolsljHAsxfXHyLuu_C55AXbQ1H9E,331886
+properdocs_theme_mkdocs/js/darkmode.js,sha256=ZmDKkKCzS-aO3QUDEC0BPm1OotTtj_3KHvF-K2kibZA,2618
+properdocs_theme_mkdocs/locales/de/LC_MESSAGES/messages.mo,sha256=E4p4m-NvV8opXn_zHzXIpJI6nlFzH6O-vo8b9oWX0ag,1535
+properdocs_theme_mkdocs/locales/es/LC_MESSAGES/messages.mo,sha256=Kp5i3WjtkbVDlAa7Xj3lDFFTWSAuSd8QpKVG2gAgP_g,1531
+properdocs_theme_mkdocs/locales/fa/LC_MESSAGES/messages.mo,sha256=sS9up0L1pEPpOdxPf7FT2WZKasDCAx_W0rFoWHMZxOY,1635
+properdocs_theme_mkdocs/locales/fr/LC_MESSAGES/messages.mo,sha256=JO6TtLwVlFuLYf1DTFIFayk1jUvoFLTzpgkAbAKWMeo,1452
+properdocs_theme_mkdocs/locales/id/LC_MESSAGES/messages.mo,sha256=TbYBu0SBZv6n1q4SxWo1qEQ2lCACDLHHytyg4n2jHt0,1516
+properdocs_theme_mkdocs/locales/it/LC_MESSAGES/messages.mo,sha256=HHpzTialITi_0piYIus-aPYnTouLKsoOhZcDvrORFc8,1512
+properdocs_theme_mkdocs/locales/ja/LC_MESSAGES/messages.mo,sha256=T5MZld5grmNw0gDRbZzYDOiFcZrrE7AZm9HfbV3FEJE,1564
+properdocs_theme_mkdocs/locales/nb/LC_MESSAGES/messages.mo,sha256=mNBX094pOW_qJz0NNn6w63lRm6XHzBJ5YCv9Dfrmlgs,1468
+properdocs_theme_mkdocs/locales/nl/LC_MESSAGES/messages.mo,sha256=vc4tz26zqH1peNrXhvmQ-_n1iQMXHdPii0iIqgHddfo,1475
+properdocs_theme_mkdocs/locales/nn/LC_MESSAGES/messages.mo,sha256=FeOfJukzINN_kABVS0nixmbfi-BR_XO4wIHQJG_fI1k,1449
+properdocs_theme_mkdocs/locales/pl/LC_MESSAGES/messages.mo,sha256=6NEJ1yf9P6AOLO14ZJjy5lk0-O2xqT2m50l4VD5D3jI,1588
+properdocs_theme_mkdocs/locales/pt_BR/LC_MESSAGES/messages.mo,sha256=HwhZFNrOb5JIxjrZ2RUNCdOcIcFSSMnyaej8XK2yL-Q,1519
+properdocs_theme_mkdocs/locales/ru/LC_MESSAGES/messages.mo,sha256=yGxJBbEJdEONWC4ZRtT9tyAW8wEJ2AW6bj5MOCLZ2oY,1858
+properdocs_theme_mkdocs/locales/tr/LC_MESSAGES/messages.mo,sha256=NV5XAGtG_51N8mR1Og-NnLFeF2-1E7Z1-7B2POh15hY,1471
+properdocs_theme_mkdocs/locales/uk/LC_MESSAGES/messages.mo,sha256=RsamCCe2tq-EemZjbIIZ-9CorWyBlsOYVopuARFsayQ,1783
+properdocs_theme_mkdocs/locales/zh_CN/LC_MESSAGES/messages.mo,sha256=ujNr1Mcp5VaWENF16tbehAjBX3Ur-p2q3wihvtOqrDk,1471
+properdocs_theme_mkdocs/locales/zh_TW/LC_MESSAGES/messages.mo,sha256=VR3UyVTl9-OKenG_2pRd81SHZp-MskmFjvF6WwsVOAE,1491
+properdocs_theme_mkdocs/webfonts/fa-brands-400.ttf,sha256=VlbVlrxZcWWkIYL2eyufF9KuR6nj7xsEK5pylzlzBwU,207972
+properdocs_theme_mkdocs/webfonts/fa-brands-400.woff2,sha256=OokkzVIDooYocWrttc7wlD2kw7ROP_zukKsGOHtBxJA,117372
+properdocs_theme_mkdocs/webfonts/fa-regular-400.ttf,sha256=XQLcm4WOPIWnlPh-N5hX9P7cTibPFQAXFKmg4LHSKU0,68004
+properdocs_theme_mkdocs/webfonts/fa-regular-400.woff2,sha256=K8zs8Lx-ls1c5AA6vrOunuSj0ZFYxObt_S3zLS8NVyE,25452
+properdocs_theme_mkdocs/webfonts/fa-solid-900.ttf,sha256=-78G10N6ow881EyWg4AZNUWo_D6t-3rYl7uxAe7-xaI,419720
+properdocs_theme_mkdocs/webfonts/fa-solid-900.woff2,sha256=n8hfOkVEqw1XDH-Pm7uI242Sw1mycHWA6osHx1Zz6uI,156496
+properdocs_theme_mkdocs/webfonts/fa-v4compatibility.ttf,sha256=CWY6NvwF5xkK-DJLhVEFxbtRGtlPlLgbNK_uUDJ57KI,10832
+properdocs_theme_mkdocs/webfonts/fa-v4compatibility.woff2,sha256=TUotf9HGaEhFyxdP3X_Ac71ky3QShvskf4t2wre4UsQ,4792
+properdocs_theme_mkdocs-1.6.5.dist-info/METADATA,sha256=AVI38LVLiZ2j3e97bKn1lgp7x4AnqBLgz9vcHjRoa9E,1340
+properdocs_theme_mkdocs-1.6.5.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+properdocs_theme_mkdocs-1.6.5.dist-info/entry_points.txt,sha256=DxF-8BrDUpXJiZCs3yMrK1sxWqCqiTqdQnaRbGd5tj4,53
+properdocs_theme_mkdocs-1.6.5.dist-info/licenses/LICENSE,sha256=JgQb1iX8OUEdxLMnSCFiNpMckErbkMKz4LppcJCl1U4,1292
+properdocs_theme_mkdocs-1.6.5.dist-info/RECORD,,

properdocs_theme_mkdocs-1.6.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

properdocs_theme_mkdocs-1.6.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[properdocs.themes]
+mkdocs = properdocs_theme_mkdocs

properdocs_theme_mkdocs-1.6.5.dist-info/licenses/LICENSE

@@ -0,0 +1,26 @@
+Copyright © 2014-present, Tom Christie. All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.