Merge pull request #796 from alina-derkach-oaza/fix-sphinx-version

Fix sphinx error that crashes the docs build (3.5.7)

config/sphinx-build/_static/_templates/theme/layout.html

@@ -22,10 +22,20 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
     <meta property="og:title" content="Percona Toolkit Documentation" />
     <meta property="og:description" content="Command-line tools for common MySQL database administration tasks." />
     <meta property="og:url" content="https://docs.percona.com/percona-toolkit/" />
+    <script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
 {% endblock %}
 
 {%- block relbar2 %}
 {% include "relbar2.html" %}
 {%- endblock %}
 
+{%- block extrafooter %}
+<a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
+{{ super() }}
+{%- endblock %}
+
+
+{# Adds Osano cookie module #}
+{% set script_files = script_files + ["_static/osano.js"] %}
+
 

config/sphinx-build/_static/_templates/theme/relbar2.html

@@ -1,15 +1,13 @@
 <div class="md-relbar2__inner md-grid">
-<div class="md-content">
-  <article class="md-content__inner md-typeset" role="main">
-    <h4>Contact Us </h4>
-       <p>For free technical help, visit the Percona <a class="reference external" href="https://forums.percona.com/c/mongodb/percona-server-for-mongodb/17?utm_campaign=Doc%20pages" target="_blank">Community Forum</a>.<br>
-        <p>To report bugs or submit feature requests, open a <a class="reference external" href="https://jira.percona.com/projects/PT/issues/" target="_blank">JIRA</a> ticket.<br>
-         <p>For paid <a class="reference external" href="https://www.percona.com/services/support"> support </a> and <a class="reference external" href="https://www.percona.com/services/managed-services"> managed </a> or <a class="reference external" href="https://www.percona.com/services/consulting">consulting services </a>, contact <a class="reference external" href="https://www.percona.com/about-percona/contact" target="_blank">Percona Sales</a>.</p>
-         <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=332312ec-2ca5-4b0f-8ceb-1e30b5eac769" />
-         <hr>
-         {# Add the last updated timestamp from git commits using gitstamp extension #}
-         {%- if gitstamp %} <small> Last update: {{gitstamp}} </small>
-         {%- endif %}
- </article>
-</div>
-</div>
+  <div class="md-content">
+    <article class="md-content__inner md-typeset" role="main">
+      <h4>Get Expert Help </h4>
+         <p>If you need assistance, visit the <a class="reference external" href="https://forums.percona.com/c/polyglot-projects/percona-toolkit/13" target="_blank">community forum</a> for comprehensive and free database knowledge.</p> 
+         <p>Contact our <a class="reference external" href="https://www.percona.com/about/contact">Percona Database Experts</a> for professional support and services.</p>
+           <hr>
+           {# Add the last updated timestamp from git commits using gitstamp extension #}
+           {%- if gitstamp %} <small> Last update: {{gitstamp}} </small>
+           {%- endif %}
+   </article>
+  </div>
+  </div>

config/sphinx-build/_static/osano.js

@@ -0,0 +1 @@
+<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>

config/sphinx-build/conf.py

@@ -41,7 +41,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Percona Toolkit'
-copyright = u'2023, Percona LLC and/or its affiliates'
+copyright = u'2024, Percona LLC and/or its affiliates'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -141,8 +141,10 @@ html_short_title = 'Percona Toolkit'
 # Path to custom css files. These will override the default css attribute if they exist
 html_css_files = [
     '_static/css/material.css',
+    '_static/css/osano.css',
 ]
 
+
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 #html_last_updated_fmt = '%b %d, %Y'

docs/release_notes.rst

@@ -19,9 +19,8 @@ Improvements
 
 * :jirabug:`PT-1860`: pt-osc case sensitivity issue (Thanks to ikruglov implementing this improvement)
 * `PR-388`: Check undefined skip check slave lag schema change (Thanks to Chrys Swingler for the contribution)
-* `PR-471`: Support adding explain output for slow query in JSON
-report as well (Thanks to Ayush Goyal for the contribution)
-* `PR-509`: added new hook before_die (Thanks to Ilaria Migliozzi for the contribution)
+* `PR-471`: Support adding explain output for slow query in JSON report as well (Thanks to Ayush Goyal for the contribution)
+* `PR-509`: Added new hook before_die (Thanks to Ilaria Migliozzi for the contribution)
 * `PR-681`: Introduce EditorConfig (Thanks to Viktor Szépe for the contribution)
 * `PR-691`: Fix newly discovered typos (Thanks to Viktor Szépe for the contribution)
 * `PR-706`: Follow PR-429 unstop option with testcase (Thanks to fraff for the contribution)
@@ -30,20 +29,20 @@ report as well (Thanks to Ayush Goyal for the contribution)
 * `PR-714`: Fix MongoDB Security (Thanks to Viktor Szépe for the contribution)
 * `PR-715`: Fix variable collision with imported package name (Thanks to Viktor Szépe for the contribution)
 * `PR-716`: Make OrderedBy not exported (Thanks to Viktor Szépe for the contribution)
-* `PR-720`: build Go tools from top Makefile (Thanks to Sami Ahlroos and Yoann La Cancellera for the contribution)
+* `PR-720`: Build Go tools from top Makefile (Thanks to Sami Ahlroos and Yoann La Cancellera for the contribution)
 
 Bugs Fixed
 ------------
 
 * :jirabug:`PT-2064`: pt-archiver: Can't call method "rollback" on an undefined value (Thanks to Jakob for the contribution)
-* :jirabug:`PT-2083`: Pt-archiver --charset option is not working for MySQL8.0 (Thanks to Yijian Zhang for reporting this issue)
+* :jirabug:`PT-2083`: pt-archiver --charset option is not working for MySQL8.0 (Thanks to Yijian Zhang for reporting this issue)
 * :jirabug:`PT-2109`: pt-mysql-summary throws an error when using sql_mode="ANSI_QUOTES"
 * :jirabug:`PT-2207`: pt-archiver doesn't work when ANSI_QUOTES is set in sql_mode
 * :jirabug:`PT-2211`: This pstack return error code line number (Thanks to Zongzhi Chen for the contribution)
 * :jirabug:`PT-2268`: pt-online-schema-change 3.5.5 breaks on mysql5.7 with server_id 0 (Thanks to Hristo Mitev for reporting this issue)
 * :jirabug:`PT-2277`: pt-visual-explain errors out on some valid inputs (Thanks to Jason Ng for the contribution)
 * :jirabug:`PT-2279`: Option --charset is confusing when set to utf8mb4
-* :jirabug:`PT-2281`: provide container name for copying files in the dump
+* :jirabug:`PT-2281`: Provide container name for copying files in the dump
 * :jirabug:`PT-2286`: CVE reported in Percona Toolkit version 3.5.5 related to GO (Thanks to Kushal Haldar for reporting this issue)
 
 v3.5.5 released 2023-10-03

requirements-docbuild.txt

@@ -1,4 +1,4 @@
-Sphinx==4.2.0
+Sphinx==5.0
 sphinx-copybutton
 sphinx-gitstamp
 sphinx-material