-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfiles.xhtml
119 lines (113 loc) · 5.3 KB
/
files.xhtml
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Files</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/epub.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="body" role="main">
<section id="files">
<h1>Files</h1>
<section id="structure">
<h2>Structure</h2>
<p>At any given commit, the files in a <code class="docutils literal notranslate"><span class="pre">repub</span></code> archive should contain:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>spec</p></th>
<th class="head text-right"><p>parent</p></th>
<th class="head"><p>name</p></th>
<th class="head"><p>format</p></th>
<th class="head"><p>content note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>epub</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">mimetype</span></code></p></td>
<td><p>text</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p>epub</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./META-INF/</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">container.xml</span></code></p></td>
<td><p>XML</p></td>
<td><p>container meta</p></td>
</tr>
<tr class="row-even"><td><p>epub</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./OEBPS/</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">content.opf</span></code></p></td>
<td><p>XML</p></td>
<td><p>content meta</p></td>
</tr>
<tr class="row-odd"><td><p>whl</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./{:name}-{:version}.dist-info/</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">METADATA</span></code></p></td>
<td><p>email</p></td>
<td><p>wheel meta</p></td>
</tr>
<tr class="row-even"><td><p>whl</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./{:name}-{:version}.dist-info/</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">WHEEL</span></code></p></td>
<td><p>email</p></td>
<td><p>wheel generator meta</p></td>
</tr>
<tr class="row-odd"><td><p>whl</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./{:name}-{:version}.dist-info/</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">RECORD</span></code></p></td>
<td><p>CSV</p></td>
<td><p>list of other files</p></td>
</tr>
<tr class="row-even"><td><p>whl</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./{:name}</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">__init__.py</span></code></p></td>
<td><p>python</p></td>
<td><p>minimum python source folder</p></td>
</tr>
<tr class="row-odd"><td><p>http</p></td>
<td class="text-right"><p><code class="docutils literal notranslate"><span class="pre">./</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">index.html</span></code></p></td>
<td><p>HTML</p></td>
<td><p>entrypoint for HTML viewer</p></td>
</tr>
</tbody>
</table>
</section>
<section id="parameters">
<h2>Parameters</h2>
<section id="name">
<h3><code class="docutils literal notranslate"><span class="pre">{:name}</span></code></h3>
<p>A python-safe package name, usually <code class="docutils literal notranslate"><span class="pre">[a-z]([a-z\d_\-]+)</span></code></p>
</section>
<section id="version">
<h3><code class="docutils literal notranslate"><span class="pre">{:version}</span></code></h3>
<p>A python-safe version number, usually <code class="docutils literal notranslate"><span class="pre">[\d](\.[\d])((a|b|rc|dev)\d+)</span></code></p>
</section>
</section>
<section id="outputs">
<h2>Outputs</h2>
<section id="epub">
<h3><code class="docutils literal notranslate"><span class="pre">.epub</span></code></h3>
<p>Generally requires no renaming.</p>
</section>
<section id="whl">
<h3><code class="docutils literal notranslate"><span class="pre">.whl</span></code></h3>
<p>Sometimes requires renaming to the valid form:</p>
<p><code class="docutils literal notranslate"><span class="pre">{:name}-{:version}-py3-none-any.whl</span></code></p>
</section>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>