Изменение конфига RTD (10)

.github/workflows/.readthedocs.yaml

@@ -6,14 +6,14 @@
 version: 2
 
 # Set the OS, Python version and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
+# build:
+#   os: ubuntu-22.04
+#   tools:
+#     python: "3.12"
+#     # You can also specify other tool versions:
+#     # nodejs: "20"
+#     # rust: "1.70"
+#     # golang: "1.20"
 
 # Build documentation in the docs/ directory with Sphinx
 # sphinx:
@@ -28,6 +28,6 @@ formats:
   - pdf
 
 # Optionally set the version of Python and requirements required to build your docs
-python:
-  install:
-    - requirements: docs/requirements.txt
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

docs/mkdocs.yml

@@ -1,6 +1,7 @@
 site_name: Firesteel
 theme:
-  name: sphinxawesome-theme
+  name: null
+  custom_dir: 'mkdocs_windmill_dark/'
   highlightjs: true
 plugins:
   - search
@@ -11,10 +12,10 @@ plugins:
           options:
             docstring_style: sphinx
 nav:
-    - Туториалы:
-        - Основа: tutorials/home.md
-        - Пакеты: tutorials/packets.md
-        - Первый треугольник: tutorials/triangle.md
+  - Туториалы:
+    - Основа: tutorials/home.md
+    - Пакеты: tutorials/packets.md
+    - Первый треугольник: tutorials/triangle.md
 markdown_extensions:
   - markdown_include.include:
       base_path: .

docs/mkdocs_windmill_dark/404.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+  <h2 style="text-align: center">404</h2>
+  <h1 style="text-align: center">Page not found</h1>
+
+{% endblock %}

docs/mkdocs_windmill_dark/LICENSE

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

docs/mkdocs_windmill_dark/article-nav.html

@@ -0,0 +1,37 @@
+{% block article_nav %}
+  {%- if page and (page.next_page or page.previous_page) %}
+
+    {# Workaround to keep mkdocs 0.17 working for now, which has no 'url' filter. #}
+    {% if mkdocs_version >= "1" %}
+      {% from "page-nav-urls.html" import next_page, prev_page with context %}
+    {% else %}
+      {% set next_page = page.next_page.url %}
+      {% set prev_page = page.previous_page.url %}
+    {% endif %}
+
+  <div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
+    {% if page.next_page %}
+    <div class="wm-article-nav pull-right">
+      <a href="{{ next_page }}" class="btn btn-xs btn-default pull-right">
+        Next
+        <i class="fa fa-chevron-right" aria-hidden="true"></i>
+      </a>
+      <a href="{{ next_page }}" class="btn btn-xs btn-link">
+        {{ page.next_page.title }}
+      </a>
+    </div>
+    {% endif %}
+
+    {%- if page.previous_page %}
+    <div class="wm-article-nav">
+      <a href="{{ prev_page }}" class="btn btn-xs btn-default pull-left">
+        <i class="fa fa-chevron-left" aria-hidden="true"></i>
+        Previous</a><a href="{{ prev_page }}" class="btn btn-xs btn-link">
+        {{ page.previous_page.title }}
+      </a>
+    </div>
+    {% endif %}
+  </div>
+
+  {%- endif %}
+{% endblock %}

docs/mkdocs_windmill_dark/base.html

@@ -0,0 +1,166 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  {% set is_top = (page and page.is_homepage) and not force_plain_page %}
+  {% set base_url = base_url or "." %}
+
+  {%- block site_meta %}
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    {% if page and page.is_homepage %}<meta name="description" content="{{ config.site_description }}">{% endif %}
+    {% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
+    {% if page and page.canonical_url %}<link rel="canonical" href="{{ page.canonical_url }}">{% endif %}
+    {% if config.site_favicon %}<link rel="shortcut icon" href="{{ base_url }}/{{ config.site_favicon }}">
+    {% else %}<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">{% endif %}
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
+  {%- endblock %}
+
+  {%- block htmltitle %}
+    <title>{% if page and page.title and not page.is_homepage %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
+  {%- endblock %}
+
+  {%- block styles %}
+    <link href="{{ base_url }}/css/bootstrap-3.3.7.min.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/font-awesome-4.7.0.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/base.css" rel="stylesheet">
+    <link rel="stylesheet" href="{{ base_url }}/css/highlight.css">
+    {%- for path in extra_css %}
+    <link href="{{ path }}" rel="stylesheet">
+    {%- endfor %}
+  {%- endblock %}
+
+  {%- block libs %}
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+        <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+        <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+    <![endif]-->
+
+    <script src="{{ base_url }}/js/jquery-3.2.1.min.js"></script>
+    <script src="{{ base_url }}/js/bootstrap-3.3.7.min.js"></script>
+    <script src="{{ base_url }}/js/highlight.pack.js"></script>
+    {% if is_top %}
+      <script src="{{ base_url }}/js/elasticlunr.min.js"></script>
+    {% endif %}
+    <base target="_top">
+  {%- endblock %}
+
+  {%- block scripts %}
+    <script>
+      var base_url = '{{ base_url }}';
+      var is_top_frame = {% if is_top %}(window === window.parent){% else %}false{% endif %};
+      {%- if page %}
+        {# Include the first two levels of TOC data as a JS object, to be rendered in top frame #}
+        var pageToc = [
+        {%- for item in page.toc %}
+          {title: {{ item.title|tojson }}, url: {{ ('#_top' if loop.first else item.url)|tojson }}, children: [
+            {%- for item in item.children %}
+              {title: {{ item.title|tojson }}, url: {{ item.url|tojson }} },
+            {%- endfor %}
+          ]},
+        {%- endfor %}
+        ];
+      {%- else %}
+        var page_toc = null;
+      {%- endif %}
+
+    </script>
+    <script src="{{ base_url }}/js/base.js"></script>
+    {%- for path in extra_javascript %}
+      <script src="{{ path }}"></script>
+    {%- endfor %}
+  {%- endblock %}
+
+  {%- block analytics %}
+    {%- if config.google_analytics %}
+    <script>
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+        ga('create', '{{ config.google_analytics[0] }}', '{{ config.google_analytics[1] }}');
+        ga('send', 'pageview');
+    </script>
+    {%- endif %}
+  {%- endblock %}
+
+  {%- block extrahead %} {% endblock %}
+</head>
+
+<body>
+<script>
+if (is_top_frame) { $('body').addClass('wm-top-page'); }
+</script>
+
+{#
+ # Code for the top frame. It should ideally be separate from the index page (which is likely
+ # possible once theme_config is released with mkdocs 1.0).
+ #}
+{%- if is_top -%}
+  {% include 'topbar.html' %}
+
+  <div id="main-content" class="wm-page-top-frame">
+    {% include 'nav-pane.html' %}
+    <div class="wm-content-pane">
+      <iframe class="wm-article" name="article"></iframe>
+    </div>
+  </div>
+
+{%- endif -%}
+
+{# Code for the main template for all content pages. #}
+
+<div class="container-fluid wm-page-content">
+  <a name="_top"></a>
+  {%- if config.extra.article_nav_top != False %}
+    {% include "article-nav.html" %}
+  {%- endif %}
+
+  {%- block content %}
+    {% if page and page.meta.source %}
+      <div class="source-links">
+      {% for filename in page.meta.source %}
+          <span class="label label-primary">{{ filename }}</span>
+      {% endfor %}
+      </div>
+    {% endif %}
+
+    {{ page.content }}
+  {%- endblock %}
+
+  <br>
+  {%- if config.extra.article_nav_bottom != False %}
+    {% include "article-nav.html" %}
+    <br>
+  {%- endif %}
+</div>
+
+<footer class="col-md-12 wm-page-content">
+{%- block footer %}
+  {%- block repo %}
+    {%- if page and page.edit_url %}
+      <p>
+        <a href="{{ page.edit_url }}">{% include 'repo-icon.html' %}Edit on {{ config.repo_name }}</a>
+      </p>
+    {%- elif config.repo_url %}
+      <p>
+        <a href="{{ config.repo_url }}">{% include 'repo-icon.html' %}{{ config.repo_name }}</a>
+      </p>
+    {%- endif %}
+  {%- endblock %}
+
+  {%- if config.copyright %}<p>{{ config.copyright }}</p>{%- endif %}
+  <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a> using <a href="https://github.com/noraj/mkdocs-windmill-dark">Windmill Dark</a> theme by Alexandre ZANNI (noraj).</p>
+{%- endblock %}
+</footer>
+
+</body>
+</html>
+{%- if is_top %}
+<!--
+MkDocs version : {{ mkdocs_version }}
+Build Date UTC : {{ build_date_utc }}
+-->
+{%- endif %}