Skip to content

Commit 57051fd

Browse files
github-actions[bot]github-actions[bot]
committed
Deployed 67e7705 to v1.13-dev with ProperDocs 1.6.7 and mike 2.2.0
1 parent e04749a commit 57051fd

4 files changed

Lines changed: 192 additions & 45 deletions

File tree

‎v1.13-dev/CONTRIBUTING/index.html‎

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1574,17 +1574,6 @@
15741574
</span>
15751575
</a>
15761576

1577-
</li>
1578-
1579-
<li class="md-nav__item">
1580-
<a href="#cross-arch-testing" class="md-nav__link">
1581-
<span class="md-ellipsis">
1582-
1583-
Cross-Arch Testing
1584-
1585-
</span>
1586-
</a>
1587-
15881577
</li>
15891578

15901579
</ul>
@@ -1680,17 +1669,6 @@
16801669
</span>
16811670
</a>
16821671

1683-
</li>
1684-
1685-
<li class="md-nav__item">
1686-
<a href="#cross-arch-testing" class="md-nav__link">
1687-
<span class="md-ellipsis">
1688-
1689-
Cross-Arch Testing
1690-
1691-
</span>
1692-
</a>
1693-
16941672
</li>
16951673

16961674
</ul>
@@ -1744,11 +1722,11 @@ <h3 id="running-tests-checks-individually">Running tests / checks individually<a
17441722
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>pytest<span class="w"> </span>tests/test_*.py
17451723
</span></code></pre></div>
17461724
<p>Or you can use <code>nox</code>:</p>
1747-
<div class="language-sh highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>pytest<span class="w"> </span>--<span class="w"> </span>test/test_*.py
1725+
<div class="language-sh highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>pytest<span class="w"> </span>--<span class="w"> </span>tests/test_*.py
17481726
</span></code></pre></div>
17491727
<p>The same appliest to <code>pylint</code> or <code>mypy</code> for example:</p>
1750-
<div class="language-sh highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>pylint<span class="w"> </span>--<span class="w"> </span>test/test_*.py
1751-
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>mypy<span class="w"> </span>--<span class="w"> </span>test/test_*.py
1728+
<div class="language-sh highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>pylint<span class="w"> </span>--<span class="w"> </span>tests/test_*.py
1729+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>nox<span class="w"> </span>-R<span class="w"> </span>-s<span class="w"> </span>mypy<span class="w"> </span>--<span class="w"> </span>tests/test_*.py
17521730
</span></code></pre></div>
17531731
<h3 id="building-the-documentation">Building the documentation<a class="headerlink" href="#building-the-documentation" title="Permanent link">¤</a></h3>
17541732
<p>To build the documentation, first install the dependencies (if you didn't
@@ -1833,24 +1811,6 @@ <h2 id="releasing">Releasing<a class="headerlink" href="#releasing" title="Perma
18331811
<ol>
18341812
<li>Celebrate!</li>
18351813
</ol>
1836-
<h2 id="cross-arch-testing">Cross-Arch Testing<a class="headerlink" href="#cross-arch-testing" title="Permanent link">¤</a></h2>
1837-
<p>This project has built-in support for testing across multiple architectures.
1838-
Currently, our CI conducts tests on <code>arm64</code> machines using QEMU emulation. We
1839-
also have the flexibility to expand this support to include additional
1840-
architectures in the future.</p>
1841-
<p>This project contains Dockerfiles that can be used in the CI to test the
1842-
python package in non-native machine architectures, e.g., <code>arm64</code>. The
1843-
Dockerfiles exist in the directory <code>.github/containers/nox-cross-arch</code>, and
1844-
follow a naming scheme so that they can be easily used in build matrices in the
1845-
CI, in <code>nox-cross-arch</code> job. The naming scheme is:</p>
1846-
<div class="language-text highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>&lt;arch&gt;-&lt;os&gt;-python-&lt;python-version&gt;.Dockerfile
1847-
</span></code></pre></div>
1848-
<p>E.g.,</p>
1849-
<div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>arm64-ubuntu-20.04-python-3.11.Dockerfile
1850-
</span></code></pre></div>
1851-
<p>If a Dockerfile for your desired target architecture, OS, and python version
1852-
does not exist here, please add one before proceeding to add your options to
1853-
the test matrix.</p>
18541814

18551815

18561816

‎v1.13-dev/_scripts/__pycache__/macros.cpython-311.pyc‎

0 Bytes
Binary file not shown.

‎v1.13-dev/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎versions.json‎

Lines changed: 188 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,188 @@
1-
[{"version":"v1.13-dev","title":"v1.13-dev (fec874e)","aliases":["latest-dev","v1-dev"]},{"version":"v1.12-dev","title":"v1.12-dev (33a83ed)","aliases":[]},{"version":"v1.12","title":"v1.12.0","aliases":["latest","v1"]},{"version":"v1.11-dev","title":"v1.11-dev (7d08b5b)","aliases":[]},{"version":"v1.11","title":"v1.11.0","aliases":[]},{"version":"v1.10-dev","title":"v1.10-dev (0970c72)","aliases":[]},{"version":"v1.10","title":"v1.10.0","aliases":[]},{"version":"v1.9-dev","title":"v1.9-dev (b5ae33c)","aliases":[]},{"version":"v1.9","title":"v1.9.0","aliases":[]},{"version":"v1.8-dev","title":"v1.8-dev (9e67b90)","aliases":[]},{"version":"v1.8","title":"v1.8.0","aliases":[]},{"version":"v1.7-dev","title":"v1.7-dev (cc19e0e)","aliases":[]},{"version":"v1.7","title":"v1.7.0","aliases":[]},{"version":"v1.6-dev","title":"v1.6-dev (cd54c44)","aliases":[]},{"version":"v1.6","title":"v1.6.1","aliases":[]},{"version":"v1.5-dev","title":"v1.5-dev (aceb7c5)","aliases":[]},{"version":"v1.5","title":"v1.5.0","aliases":[]},{"version":"v1.4-dev","title":"v1.4-dev (f4a6642)","aliases":[]},{"version":"v1.4","title":"v1.4.0","aliases":[]},{"version":"v1.3-dev","title":"v1.3-dev (b3c98e5)","aliases":[]},{"version":"v1.3","title":"v1.3.0","aliases":[]},{"version":"v1.2-dev","title":"v1.2-dev (224519c)","aliases":[]},{"version":"v1.2","title":"v1.2.1","aliases":[]},{"version":"v1.1-dev","title":"v1.1-dev (779e807)","aliases":[]},{"version":"v1.1","title":"v1.1.2","aliases":[]},{"version":"v1.0-dev","title":"v1.0-dev (d9b7d22)","aliases":[]},{"version":"v1.0","title":"v1.0.1","aliases":[]},{"version":"v1.0-pre","title":"v1.0.0-rc.1","aliases":["v1-pre","latest-pre"]},{"version":"v0.16","title":"v0.16.0","aliases":["v0"]},{"version":"v0.15","title":"v0.15.1","aliases":[]},{"version":"v0.14","title":"v0.14.0","aliases":[]},{"version":"v0.13","title":"v0.13.0","aliases":[]},{"version":"v0.12","title":"v0.12.0","aliases":[]},{"version":"v0.11","title":"v0.11.0","aliases":[]},{"version":"v0.10","title":"v0.10.1","aliases":[]}]
1+
[
2+
{
3+
"version": "v1.13-dev",
4+
"title": "v1.13-dev (67e7705)",
5+
"aliases": [
6+
"latest-dev",
7+
"v1-dev"
8+
]
9+
},
10+
{
11+
"version": "v1.12",
12+
"title": "v1.12.0",
13+
"aliases": [
14+
"v1",
15+
"latest"
16+
]
17+
},
18+
{
19+
"version": "v1.12-dev",
20+
"title": "v1.12-dev (33a83ed)",
21+
"aliases": []
22+
},
23+
{
24+
"version": "v1.11",
25+
"title": "v1.11.0",
26+
"aliases": []
27+
},
28+
{
29+
"version": "v1.11-dev",
30+
"title": "v1.11-dev (7d08b5b)",
31+
"aliases": []
32+
},
33+
{
34+
"version": "v1.10",
35+
"title": "v1.10.0",
36+
"aliases": []
37+
},
38+
{
39+
"version": "v1.10-dev",
40+
"title": "v1.10-dev (0970c72)",
41+
"aliases": []
42+
},
43+
{
44+
"version": "v1.9",
45+
"title": "v1.9.0",
46+
"aliases": []
47+
},
48+
{
49+
"version": "v1.9-dev",
50+
"title": "v1.9-dev (b5ae33c)",
51+
"aliases": []
52+
},
53+
{
54+
"version": "v1.8",
55+
"title": "v1.8.0",
56+
"aliases": []
57+
},
58+
{
59+
"version": "v1.8-dev",
60+
"title": "v1.8-dev (9e67b90)",
61+
"aliases": []
62+
},
63+
{
64+
"version": "v1.7",
65+
"title": "v1.7.0",
66+
"aliases": []
67+
},
68+
{
69+
"version": "v1.7-dev",
70+
"title": "v1.7-dev (cc19e0e)",
71+
"aliases": []
72+
},
73+
{
74+
"version": "v1.6",
75+
"title": "v1.6.1",
76+
"aliases": []
77+
},
78+
{
79+
"version": "v1.6-dev",
80+
"title": "v1.6-dev (cd54c44)",
81+
"aliases": []
82+
},
83+
{
84+
"version": "v1.5",
85+
"title": "v1.5.0",
86+
"aliases": []
87+
},
88+
{
89+
"version": "v1.5-dev",
90+
"title": "v1.5-dev (aceb7c5)",
91+
"aliases": []
92+
},
93+
{
94+
"version": "v1.4",
95+
"title": "v1.4.0",
96+
"aliases": []
97+
},
98+
{
99+
"version": "v1.4-dev",
100+
"title": "v1.4-dev (f4a6642)",
101+
"aliases": []
102+
},
103+
{
104+
"version": "v1.3",
105+
"title": "v1.3.0",
106+
"aliases": []
107+
},
108+
{
109+
"version": "v1.3-dev",
110+
"title": "v1.3-dev (b3c98e5)",
111+
"aliases": []
112+
},
113+
{
114+
"version": "v1.2",
115+
"title": "v1.2.1",
116+
"aliases": []
117+
},
118+
{
119+
"version": "v1.2-dev",
120+
"title": "v1.2-dev (224519c)",
121+
"aliases": []
122+
},
123+
{
124+
"version": "v1.1",
125+
"title": "v1.1.2",
126+
"aliases": []
127+
},
128+
{
129+
"version": "v1.1-dev",
130+
"title": "v1.1-dev (779e807)",
131+
"aliases": []
132+
},
133+
{
134+
"version": "v1.0",
135+
"title": "v1.0.1",
136+
"aliases": []
137+
},
138+
{
139+
"version": "v1.0-pre",
140+
"title": "v1.0.0-rc.1",
141+
"aliases": [
142+
"latest-pre",
143+
"v1-pre"
144+
]
145+
},
146+
{
147+
"version": "v1.0-dev",
148+
"title": "v1.0-dev (d9b7d22)",
149+
"aliases": []
150+
},
151+
{
152+
"version": "v0.16",
153+
"title": "v0.16.0",
154+
"aliases": [
155+
"v0"
156+
]
157+
},
158+
{
159+
"version": "v0.15",
160+
"title": "v0.15.1",
161+
"aliases": []
162+
},
163+
{
164+
"version": "v0.14",
165+
"title": "v0.14.0",
166+
"aliases": []
167+
},
168+
{
169+
"version": "v0.13",
170+
"title": "v0.13.0",
171+
"aliases": []
172+
},
173+
{
174+
"version": "v0.12",
175+
"title": "v0.12.0",
176+
"aliases": []
177+
},
178+
{
179+
"version": "v0.11",
180+
"title": "v0.11.0",
181+
"aliases": []
182+
},
183+
{
184+
"version": "v0.10",
185+
"title": "v0.10.1",
186+
"aliases": []
187+
}
188+
]

0 commit comments

Comments
 (0)