1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>m.sphinx | A Pelican Blog</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i" />
<link rel="stylesheet" href="static/m-dark.css" />
<link rel="canonical" href="page.html" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a href="./" id="m-navbar-brand" class="m-col-t-9 m-col-m-none m-left-m">A Pelican Blog</a>
</div>
</div>
</nav></header>
<main>
<article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>m.sphinx</h1>
<!-- content -->
<ul>
<li>Module link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/argparse.html#module-argparse">argparse</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/argparse.html#module-argparse">argparse</a></li>
</ul>
</li>
<li>Function link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/functions.html#open">open()</a></li>
<li>without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/functions.html#open">open()</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/functions.html#open">open()</a>,</li>
<li>explicit without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/functions.html#open">open()</a></li>
</ul>
</li>
<li>Class link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element">xml.etree.ElementTree.Element</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element">xml.etree.ElementTree.Element</a></li>
</ul>
</li>
<li>Classmethod link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytearray.fromhex">bytearray.fromhex()</a></li>
<li>without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytearray.fromhex">bytearray.fromhex()</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytearray.fromhex">bytearray.fromhex()</a></li>
<li>explicit without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytearray.fromhex">bytearray.fromhex()</a></li>
</ul>
</li>
<li>Staticmethod link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytes.maketrans">bytes.maketrans()</a></li>
<li>without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytes.maketrans">bytes.maketrans()</a></li>
<li>explicit type <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytes.maketrans">bytes.maketrans()</a></li>
<li>explicit without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#bytes.maketrans">bytes.maketrans()</a></li>
</ul>
</li>
<li>Method link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#str.rstrip">str.rstrip()</a></li>
<li>without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#str.rstrip">str.rstrip()</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#str.rstrip">str.rstrip()</a></li>
<li>explicit type without a <code>()</code>: <a class="m-flat" href="https://docs.python.org/3/library/stdtypes.html#str.rstrip">str.rstrip()</a></li>
</ul>
</li>
<li>Property link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/datetime.html#datetime.date.year">datetime.date.year</a></li>
<li>explicit type <a class="m-flat" href="https://docs.python.org/3/library/datetime.html#datetime.date.year">datetime.date.year</a></li>
</ul>
</li>
<li>Data link:<ul>
<li><a class="m-flat" href="https://docs.python.org/3/library/re.html#re.X">re.X</a></li>
<li>explicit type: <a class="m-flat" href="https://docs.python.org/3/library/re.html#re.X">re.X</a></li>
</ul>
</li>
<li>Explicitly typed page link with automatic title: <a class="m-flat" href="https://docs.python.org/3/using/cmdline.html">Command line and environment</a></li>
<li><a class="m-flat" href="https://docs.python.org/3/using/cmdline.html">Page link with custom link title</a>,
<a class="m-flat" href="https://docs.python.org/3/library/os.path.html#os.path.join">Function link with a custom title</a></li>
<li>Custom CSS class: <a class="m-text m-small m-flat" href="https://docs.python.org/3/library/stdtypes.html#str.join">str.join()</a></li>
<li>Omitting a prefix: <a class="m-flat" href="https://docs.python.org/3/library/xml.etree.elementtree.html#module-xml.etree.ElementTree">etree.ElementTree</a>, <a class="m-flat" href="https://docs.python.org/3/library/xml.etree.elementtree.html#module-xml.etree.ElementTree">ElementTree</a></li>
<li>Omitting a page-specific prefix defined in <code>:ref-prefix:</code>:
<a class="m-flat" href="https://docs.python.org/3/library/typing.html#typing.Tuple">Tuple</a>, <a class="m-flat" href="https://docs.python.org/3/library/unittest.mock.html#unittest.mock.NonCallableMagicMock">NonCallableMagicMock</a></li>
<li>Custom query string: <a class="m-flat" href="https://docs.python.org/3/library/os.path.html#module-os.path?q=the meaning of life">os.path</a></li>
</ul>
<p>These should produce warnings:</p>
<ul>
<li>Link to nonexistent name will be rendered as code: <code>nonexistent()</code></li>
<li><span>Link to nonexistent name with custom title will be just text</span></li>
</ul>
<!-- /content -->
</div>
</div>
</div>
</article>
</main>
</body>
</html>
|
