Skip to content

Commit 0b9b521

Browse files
committed
Docs for v3.6.1
0 parents  commit 0b9b521

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+8891
-0
lines changed

.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: fb0121939c1ff271b4185ca7189cf404
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/changelog.doctree

94.2 KB
Binary file not shown.

.doctrees/environment.pickle

2.31 MB
Binary file not shown.

.doctrees/index.doctree

146 KB
Binary file not shown.

.nojekyll

Whitespace-only changes.

_modules/argcomplete/completers.html

Lines changed: 440 additions & 0 deletions
Large diffs are not rendered by default.

_modules/argcomplete/exceptions.html

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
<!doctype html>
2+
<html class="no-js" lang="en" data-content_root="../../">
3+
<head><meta charset="utf-8"/>
4+
<meta name="viewport" content="width=device-width,initial-scale=1"/>
5+
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
6+
7+
<!-- Generated with Sphinx 8.2.1 and Furo 2024.08.06 -->
8+
<title>argcomplete.exceptions - argcomplete documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=354aac6f" />
11+
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
12+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=302659d7" />
13+
14+
15+
16+
17+
<style>
18+
body {
19+
--color-code-background: #eeffcc;
20+
--color-code-foreground: black;
21+
22+
}
23+
@media not print {
24+
body[data-theme="dark"] {
25+
--color-code-background: #202020;
26+
--color-code-foreground: #d0d0d0;
27+
28+
}
29+
@media (prefers-color-scheme: dark) {
30+
body:not([data-theme="light"]) {
31+
--color-code-background: #202020;
32+
--color-code-foreground: #d0d0d0;
33+
34+
}
35+
}
36+
}
37+
</style></head>
38+
<body>
39+
40+
<script>
41+
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
42+
</script>
43+
44+
45+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
46+
<symbol id="svg-toc" viewBox="0 0 24 24">
47+
<title>Contents</title>
48+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
49+
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
50+
</svg>
51+
</symbol>
52+
<symbol id="svg-menu" viewBox="0 0 24 24">
53+
<title>Menu</title>
54+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
55+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
56+
<line x1="3" y1="12" x2="21" y2="12"></line>
57+
<line x1="3" y1="6" x2="21" y2="6"></line>
58+
<line x1="3" y1="18" x2="21" y2="18"></line>
59+
</svg>
60+
</symbol>
61+
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
62+
<title>Expand</title>
63+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
64+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
65+
<polyline points="9 18 15 12 9 6"></polyline>
66+
</svg>
67+
</symbol>
68+
<symbol id="svg-sun" viewBox="0 0 24 24">
69+
<title>Light mode</title>
70+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
71+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
72+
<circle cx="12" cy="12" r="5"></circle>
73+
<line x1="12" y1="1" x2="12" y2="3"></line>
74+
<line x1="12" y1="21" x2="12" y2="23"></line>
75+
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
76+
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
77+
<line x1="1" y1="12" x2="3" y2="12"></line>
78+
<line x1="21" y1="12" x2="23" y2="12"></line>
79+
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
80+
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
81+
</svg>
82+
</symbol>
83+
<symbol id="svg-moon" viewBox="0 0 24 24">
84+
<title>Dark mode</title>
85+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
86+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
87+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
88+
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
89+
</svg>
90+
</symbol>
91+
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
92+
<title>Auto light/dark, in light mode</title>
93+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
94+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
95+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
96+
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
97+
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
98+
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
99+
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
100+
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
101+
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
102+
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
103+
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
104+
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
105+
<circle cx="14.5" cy="9.55" r="3.6"/>
106+
</svg>
107+
</symbol>
108+
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
109+
<title>Auto light/dark, in dark mode</title>
110+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
111+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
112+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
113+
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
114+
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
115+
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
116+
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
117+
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
118+
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
119+
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
120+
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
121+
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
122+
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
123+
</svg>
124+
</symbol>
125+
<symbol id="svg-pencil" viewBox="0 0 24 24">
126+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
127+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
128+
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
129+
<path d="M13.5 6.5l4 4" />
130+
<path d="M20 21l2 -2l-2 -2" />
131+
<path d="M17 17l-2 2l2 2" />
132+
</svg>
133+
</symbol>
134+
<symbol id="svg-eye" viewBox="0 0 24 24">
135+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
136+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
137+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
138+
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
139+
<path
140+
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
141+
<path d="M20 21l2 -2l-2 -2" />
142+
<path d="M17 17l-2 2l2 2" />
143+
</svg>
144+
</symbol>
145+
</svg>
146+
147+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
148+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
149+
<label class="overlay sidebar-overlay" for="__navigation">
150+
<div class="visually-hidden">Hide navigation sidebar</div>
151+
</label>
152+
<label class="overlay toc-overlay" for="__toc">
153+
<div class="visually-hidden">Hide table of contents sidebar</div>
154+
</label>
155+
156+
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
157+
158+
159+
160+
<div class="page">
161+
<header class="mobile-header">
162+
<div class="header-left">
163+
<label class="nav-overlay-icon" for="__navigation">
164+
<div class="visually-hidden">Toggle site navigation sidebar</div>
165+
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
166+
</label>
167+
</div>
168+
<div class="header-center">
169+
<a href="../../index.html"><div class="brand">argcomplete documentation</div></a>
170+
</div>
171+
<div class="header-right">
172+
<div class="theme-toggle-container theme-toggle-header">
173+
<button class="theme-toggle">
174+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
175+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
176+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
177+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
178+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
179+
</button>
180+
</div>
181+
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
182+
<div class="visually-hidden">Toggle table of contents sidebar</div>
183+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
184+
</label>
185+
</div>
186+
</header>
187+
<aside class="sidebar-drawer">
188+
<div class="sidebar-container">
189+
190+
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
191+
192+
193+
<span class="sidebar-brand-text">argcomplete documentation</span>
194+
195+
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
196+
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
197+
<input type="hidden" name="check_keywords" value="yes">
198+
<input type="hidden" name="area" value="default">
199+
</form>
200+
<div id="searchbox"></div><div class="sidebar-scroll"></div>
201+
</div>
202+
203+
</div>
204+
</aside>
205+
<div class="main">
206+
<div class="content">
207+
<div class="article-container">
208+
<a href="#" class="back-to-top muted-link">
209+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
210+
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
211+
</svg>
212+
<span>Back to top</span>
213+
</a>
214+
<div class="content-icon-container">
215+
<div class="theme-toggle-container theme-toggle-content">
216+
<button class="theme-toggle">
217+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
218+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
219+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
220+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
221+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
222+
</button>
223+
</div>
224+
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
225+
<div class="visually-hidden">Toggle table of contents sidebar</div>
226+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
227+
</label>
228+
</div>
229+
<article role="main" id="furo-main-content">
230+
<h1>Source code for argcomplete.exceptions</h1><div class="highlight"><pre>
231+
<div class="viewcode-block" id="ArgcompleteException">
232+
<a class="viewcode-back" href="../../index.html#argcomplete.ArgcompleteException">[docs]</a>
233+
<span></span><span class="k">class</span><span class="w"> </span><span class="nc">ArgcompleteException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
234+
<span class="s2">&quot;Exception raised when the shell argument completion process fails.&quot;</span></div>
235+
236+
</pre></div>
237+
</article>
238+
</div>
239+
<footer>
240+
241+
<div class="related-pages">
242+
243+
244+
</div>
245+
<div class="bottom-of-page">
246+
<div class="left-details">
247+
<div class="copyright">
248+
Copyright &#169; Andrey Kislyuk and argcomplete contributors
249+
</div>
250+
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
251+
252+
<a href="https://github.com/pradyunsg/furo">Furo</a>
253+
254+
</div>
255+
<div class="right-details">
256+
257+
</div>
258+
</div>
259+
260+
</footer>
261+
</div>
262+
<aside class="toc-drawer no-toc">
263+
264+
265+
266+
</aside>
267+
</div>
268+
</div><script src="../../_static/documentation_options.js?v=5929fcd5"></script>
269+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
270+
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
271+
<script src="../../_static/scripts/furo.js?v=5fa4622c"></script>
272+
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
273+
<script src="../../_static/copybutton.js?v=f281be69"></script>
274+
</body>
275+
</html>

0 commit comments

Comments
 (0)