Skip to content

Commit 4a7eab1

Browse files
docs(python): Update Python docs
1 parent 95bf583 commit 4a7eab1

15 files changed

+1849
-1891
lines changed

docs/_static/alabaster.css

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,11 @@ div.relations {
6969
}
7070

7171

72+
div.sphinxsidebar {
73+
max-height: 100%;
74+
overflow-y: auto;
75+
}
76+
7277
div.sphinxsidebar a {
7378
color: #444;
7479
text-decoration: none;
@@ -155,6 +160,14 @@ div.sphinxsidebar input {
155160
font-size: 1em;
156161
}
157162

163+
div.sphinxsidebar #searchbox input[type="text"] {
164+
width: 160px;
165+
}
166+
167+
div.sphinxsidebar .search > div {
168+
display: table-cell;
169+
}
170+
158171
div.sphinxsidebar hr {
159172
border: none;
160173
height: 1px;
@@ -638,15 +651,7 @@ a:hover tt, a:hover code {
638651
display: none!important;
639652
}
640653

641-
/* Make nested-list/multi-paragraph items look better in Releases changelog
642-
* pages. Without this, docutils' magical list fuckery causes inconsistent
643-
* formatting between different release sub-lists.
644-
*/
645-
div#changelog > div.section > ul > li > p:only-child {
646-
margin-bottom: 0;
647-
}
648-
649-
/* Hide fugly table cell borders in ..bibliography:: directive output */
654+
/* Hide ugly table cell borders in ..bibliography:: directive output */
650655
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
651656
border: none;
652657
/* Below needed in some edge cases; if not applied, bottom shadows appear */

docs/_static/basic.css

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -222,7 +222,7 @@ table.modindextable td {
222222
/* -- general body styles --------------------------------------------------- */
223223

224224
div.body {
225-
min-width: 360px;
225+
min-width: inherit;
226226
max-width: 800px;
227227
}
228228

@@ -237,6 +237,10 @@ a.headerlink {
237237
visibility: hidden;
238238
}
239239

240+
a:visited {
241+
color: #551A8B;
242+
}
243+
240244
h1:hover > a.headerlink,
241245
h2:hover > a.headerlink,
242246
h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
670674
margin-left: 30px;
671675
}
672676

677+
.sig dd {
678+
margin-top: 0px;
679+
margin-bottom: 0px;
680+
}
681+
682+
.sig dl {
683+
margin-top: 0px;
684+
margin-bottom: 0px;
685+
}
686+
673687
dl > dd:last-child,
674688
dl > dd:last-child > :last-child {
675689
margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
738752
cursor: help;
739753
}
740754

755+
.translated {
756+
background-color: rgba(207, 255, 207, 0.2)
757+
}
758+
759+
.untranslated {
760+
background-color: rgba(255, 207, 207, 0.2)
761+
}
762+
741763
/* -- code displays --------------------------------------------------------- */
742764

743765
pre {

docs/_static/doctools.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Base JavaScript utilities for all Sphinx HTML documentation.
66
*
7-
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

docs/_static/documentation_options.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
var DOCUMENTATION_OPTIONS = {
2-
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '2.7.1',
1+
const DOCUMENTATION_OPTIONS = {
2+
VERSION: '2.8.0',
43
LANGUAGE: 'en',
54
COLLAPSE_INDEX: false,
65
BUILDER: 'html',

docs/_static/language_data.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
* This script contains the language-specific data used by searchtools.js,
66
* namely the list of stopwords, stemmer, scorer and splitter.
77
*
8-
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/
1212

1313
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
1414

1515

16-
/* Non-minified version is copied as a separate JS file, is available */
16+
/* Non-minified version is copied as a separate JS file, if available */
1717

1818
/**
1919
* Porter Stemmer

docs/_static/pygments.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
2222
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
2323
.highlight .gd { color: #a40000 } /* Generic.Deleted */
2424
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
25+
.highlight .ges { color: #000000 } /* Generic.EmphStrong */
2526
.highlight .gr { color: #ef2929 } /* Generic.Error */
2627
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
2728
.highlight .gi { color: #00A000 } /* Generic.Inserted */
@@ -55,7 +56,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
5556
.highlight .nv { color: #000000 } /* Name.Variable */
5657
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
5758
.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
58-
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
59+
.highlight .w { color: #f8f8f8 } /* Text.Whitespace */
5960
.highlight .mb { color: #990000 } /* Literal.Number.Bin */
6061
.highlight .mf { color: #990000 } /* Literal.Number.Float */
6162
.highlight .mh { color: #990000 } /* Literal.Number.Hex */

0 commit comments

Comments
 (0)