-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcommandline.html
406 lines (351 loc) · 25.5 KB
/
commandline.html
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Doctr Command Line Help — Doctr 1.8.0+13.g7e75711 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Recipes" href="recipes.html" />
<link rel="prev" title="Doctr" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="doctr-command-line-help">
<h1>Doctr Command Line Help<a class="headerlink" href="#doctr-command-line-help" title="Permalink to this headline">¶</a></h1>
<section id="doctr">
<h2>doctr<a class="headerlink" href="#doctr" title="Permalink to this headline">¶</a></h2>
<p>doctr</p>
<p>A tool to automatically deploy docs to GitHub pages from Travis CI.</p>
<p>The doctr command is two commands in one. To use, first run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">doctr</span> <span class="n">configure</span>
</pre></div>
</div>
<p>on your local machine. This will prompt for your GitHub credentials and the
name of the repo you want to deploy docs for. This will generate a secure key,
which you should insert into your .travis.yml.</p>
<p>Then, on Travis, for the build where you build your docs, add:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="n">doctr</span> <span class="n">deploy</span> <span class="o">.</span> <span class="o">--</span><span class="n">built</span><span class="o">-</span><span class="n">docs</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">built</span><span class="o">/</span><span class="n">html</span><span class="o">/</span>
</pre></div>
</div>
<p>to the end of the build to deploy the docs to GitHub pages. This will only
run on the master branch, and won’t run on pull requests.</p>
<p>For more information, see <a class="reference external" href="https://drdoctr.github.io/doctr/docs/">https://drdoctr.github.io/doctr/docs/</a></p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">usage: doctr [-h] [-V] {deploy,configure} ...</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-doctr-h">
<span id="cmdoption-doctr-help"></span><code class="sig-name descname"><span class="pre">-h</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--help</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-h" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-V">
<span id="cmdoption-doctr-v"></span><span id="cmdoption-doctr-version"></span><code class="sig-name descname"><span class="pre">-V</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--version</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-V" title="Permalink to this definition">¶</a></dt>
<dd><p>show program’s version number and exit</p>
</dd></dl>
<p>Run –help on the subcommands like ‘doctr deploy –help’ to see the
options available.</p>
<section id="doctr-configure">
<h3>doctr configure<a class="headerlink" href="#doctr-configure" title="Permalink to this headline">¶</a></h3>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">usage: doctr configure [-h] [--force] [--token] [--no-upload-key]</span>
<span class="go"> [--no-authenticate] [--key-path KEY_PATH]</span>
<span class="go"> [--travis-tld {c,com,.com,travis-ci.com,o,org,.org,travis-ci.org}]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-doctr-configure-h">
<span id="cmdoption-doctr-configure-help"></span><code class="sig-name descname"><span class="pre">-h</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--help</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-configure-h" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-force">
<code class="sig-name descname"><span class="pre">--force</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-configure-force" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the configure command even
if we appear to be on Travis.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-token">
<code class="sig-name descname"><span class="pre">--token</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-configure-token" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a personal access token to push to GitHub. The default is to use a
deploy key. WARNING: This will grant read/write access to all the
public repositories for the user. This option is not recommended
unless you are using a separate GitHub user for deploying.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-no-upload-key">
<code class="sig-name descname"><span class="pre">--no-upload-key</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-configure-no-upload-key" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t automatically upload the deploy key to GitHub. To prevent doctr
configure from requiring you to login to GitHub, use
–no-authenticate.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-no-authenticate">
<code class="sig-name descname"><span class="pre">--no-authenticate</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-configure-no-authenticate" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t authenticate with GitHub. This option implies –no-upload-key. This
option is also not compatible with private repositories.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-key-path">
<code class="sig-name descname"><span class="pre">--key-path</span></code><code class="sig-prename descclassname"> <span class="pre"><key_path></span></code><a class="headerlink" href="#cmdoption-doctr-configure-key-path" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to save the encrypted GitHub deploy key. The default is github_deploy_key_+
deploy respository name. The .enc extension is added to the file automatically.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-configure-travis-tld">
<code class="sig-name descname"><span class="pre">--travis-tld</span></code><code class="sig-prename descclassname"> <span class="pre">{c,com,.com,travis-ci.com,o,org,.org,travis-ci.org}</span></code><a class="headerlink" href="#cmdoption-doctr-configure-travis-tld" title="Permalink to this definition">¶</a></dt>
<dd><p>Travis tld to use. Should be either ‘.com’ or ‘.org’. The default is to
check which the repo is activated on and ask if it is activated on
both.</p>
</dd></dl>
</section>
<section id="doctr-deploy">
<h3>doctr deploy<a class="headerlink" href="#doctr-deploy" title="Permalink to this headline">¶</a></h3>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">usage: doctr deploy [-h] [--force | --no-force] [--token | --no-token]</span>
<span class="go"> [--key-path KEY_PATH] [--built-docs BUILT_DOCS]</span>
<span class="go"> [--deploy-branch-name DEPLOY_BRANCH_NAME]</span>
<span class="go"> [--deploy-repo DEPLOY_REPO]</span>
<span class="go"> [--branch-whitelist [BRANCH [BRANCH ...]]]</span>
<span class="go"> [--no-require-master | --require-master]</span>
<span class="go"> [--command COMMAND] [--no-sync | --sync] [--no-temp-dir]</span>
<span class="go"> [--no-push | --push] [--build-tags | --no-build-tags]</span>
<span class="go"> [--gh-pages-docs GH_PAGES_DOCS]</span>
<span class="go"> [--exclude EXCLUDE [EXCLUDE ...]]</span>
<span class="go"> [deploy_directory]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-arg-deploy_directory">
<span id="cmdoption-doctr-deploy-arg-deploy-directory"></span><code class="sig-name descname"><span class="pre">deploy_directory</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-arg-deploy_directory" title="Permalink to this definition">¶</a></dt>
<dd><p>Directory to deploy the html documentation to on gh-pages.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-h">
<span id="cmdoption-doctr-deploy-help"></span><code class="sig-name descname"><span class="pre">-h</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--help</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-h" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-force">
<code class="sig-name descname"><span class="pre">--force</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-force" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the deploy command even
if we do not appear to be on Travis.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-force">
<code class="sig-name descname"><span class="pre">--no-force</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-force" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–force”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-token">
<code class="sig-name descname"><span class="pre">--token</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-token" title="Permalink to this definition">¶</a></dt>
<dd><p>Push to GitHub using a personal access token. Use this if you
used ‘doctr configure –token’.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-token">
<code class="sig-name descname"><span class="pre">--no-token</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-token" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–token”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-key-path">
<code class="sig-name descname"><span class="pre">--key-path</span></code><code class="sig-prename descclassname"> <span class="pre"><key_path></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-key-path" title="Permalink to this definition">¶</a></dt>
<dd><p>Path of the encrypted GitHub deploy key. The default is github_deploy_key_+
deploy respository name + .enc.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-built-docs">
<code class="sig-name descname"><span class="pre">--built-docs</span></code><code class="sig-prename descclassname"> <span class="pre"><built_docs></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-built-docs" title="Permalink to this definition">¶</a></dt>
<dd><p>Location of the built html documentation to be deployed to gh-pages. If not
specified, Doctr will try to automatically detect build location
(right now only works for Sphinx docs).</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-deploy-branch-name">
<code class="sig-name descname"><span class="pre">--deploy-branch-name</span></code><code class="sig-prename descclassname"> <span class="pre"><deploy_branch_name></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-deploy-branch-name" title="Permalink to this definition">¶</a></dt>
<dd><p>Name of the branch to deploy to (default: ‘master’ for <code class="docutils literal notranslate"><span class="pre">*.github.io</span></code>
and wiki repos, ‘gh-pages’ otherwise)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-deploy-repo">
<code class="sig-name descname"><span class="pre">--deploy-repo</span></code><code class="sig-prename descclassname"> <span class="pre"><deploy_repo></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-deploy-repo" title="Permalink to this definition">¶</a></dt>
<dd><p>Repo to
deploy the docs to. By default, it deploys to the repo Doctr is run from.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-branch-whitelist">
<code class="sig-name descname"><span class="pre">--branch-whitelist</span></code><code class="sig-prename descclassname"> <span class="pre"><branch></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-branch-whitelist" title="Permalink to this definition">¶</a></dt>
<dd><p>Branches to deploy from. Pass no arguments to not build on any branch
(typically used in conjunction with –build-tags). Note that you can
deploy from every branch with –no-require-master.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-require-master">
<code class="sig-name descname"><span class="pre">--no-require-master</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-require-master" title="Permalink to this definition">¶</a></dt>
<dd><p>Allow docs to be pushed from a branch other than master</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-require-master">
<code class="sig-name descname"><span class="pre">--require-master</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-require-master" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–no-require-master”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-command">
<code class="sig-name descname"><span class="pre">--command</span></code><code class="sig-prename descclassname"> <span class="pre"><command></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-command" title="Permalink to this definition">¶</a></dt>
<dd><p>Command to be run before committing and pushing. This command
will be run from the deploy repository/branch. If the command creates
additional files that should be deployed, they should be added to the
index.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-sync">
<code class="sig-name descname"><span class="pre">--no-sync</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t sync any files. This is generally used in
conjunction with the –command flag, for instance, if the command syncs
the files for you. Any files you wish to commit should be added to the
index.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-sync">
<code class="sig-name descname"><span class="pre">--sync</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–no-sync”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-temp-dir">
<code class="sig-name descname"><span class="pre">--no-temp-dir</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-temp-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t copy the
–built-docs directory to a temporary directory.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-push">
<code class="sig-name descname"><span class="pre">--no-push</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-push" title="Permalink to this definition">¶</a></dt>
<dd><p>Run all the steps except the last push step. Useful for debugging</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-push">
<code class="sig-name descname"><span class="pre">--push</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-push" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–no-push”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-build-tags">
<code class="sig-name descname"><span class="pre">--build-tags</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-build-tags" title="Permalink to this definition">¶</a></dt>
<dd><p>Deploy on tag builds. On a tag build,
$TRAVIS_TAG is set to the name of the tag. The default is to not
deploy on tag builds. Note that this will still build on a branch,
unless –branch-whitelist (with no arguments) is passed.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-no-build-tags">
<code class="sig-name descname"><span class="pre">--no-build-tags</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-doctr-deploy-no-build-tags" title="Permalink to this definition">¶</a></dt>
<dd><p>Inverse of “–build-tags”</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-gh-pages-docs">
<code class="sig-name descname"><span class="pre">--gh-pages-docs</span></code><code class="sig-prename descclassname"> <span class="pre"><gh_pages_docs></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-gh-pages-docs" title="Permalink to this definition">¶</a></dt>
<dd><p>!!DEPRECATED!! Directory to deploy the html documentation to on gh-pages.
The default is None. The deploy directory should be passed as
the first argument to ‘doctr deploy’. This flag is kept for backwards
compatibility.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-doctr-deploy-exclude">
<code class="sig-name descname"><span class="pre">--exclude</span></code><code class="sig-prename descclassname"> <span class="pre"><exclude></span></code><a class="headerlink" href="#cmdoption-doctr-deploy-exclude" title="Permalink to this definition">¶</a></dt>
<dd><p>Files and
directories from –built-docs that are not copied.</p>
</dd></dl>
</section>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>In addition to command line arguments you can configure <code class="docutils literal notranslate"><span class="pre">doctr</span></code> using the
<code class="docutils literal notranslate"><span class="pre">.travis.yml</span></code> files. Command line arguments take precedence over the value
present in the configuration file.</p>
<p>The configuration parameters available from the <code class="docutils literal notranslate"><span class="pre">.travis.yml</span></code> file mirror
their command line siblings except doubledashes <code class="docutils literal notranslate"><span class="pre">--</span></code> and <code class="docutils literal notranslate"><span class="pre">--no-</span></code> prefix are
dropped.</p>
<p>Use a <code class="docutils literal notranslate"><span class="pre">doctr</span></code> section in your <code class="docutils literal notranslate"><span class="pre">travis.yml</span></code> file to store your doctr
configuration:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">language</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">python</span>
<span class="p p-Indicator">-</span> <span class="nt">script</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">set -e</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">py.test</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">cd docs</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">make html</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">cd ..</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">doctr deploy .</span>
<span class="p p-Indicator">-</span> <span class="nt">doctr</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="nt">key-path </span><span class="p">:</span> <span class="s">'path/to/key/from/repo/root/path.key'</span>
<span class="p p-Indicator">-</span> <span class="nt">deploy-repo </span><span class="p">:</span> <span class="s">'myorg/myrepo'</span>
</pre></div>
</div>
<p>The following options are available from the configuration file and not from
the command line:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">branches</span></code>:</dt><dd><p>A list of regular expression that matches branches on which <code class="docutils literal notranslate"><span class="pre">doctr</span></code> should
still deploy the documentation. For example <code class="docutils literal notranslate"><span class="pre">.*\.x</span></code> will deploy all
branches like <code class="docutils literal notranslate"><span class="pre">3.x</span></code>, <code class="docutils literal notranslate"><span class="pre">4.x</span></code> …</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Doctr</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Doctr Command Line Help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#doctr">doctr</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="recipes.html">Recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Doctr Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Notes for testing doctr</a></li>
</ul>
<h3>Need help?</h3>
<p>
Open an issue in our <a href="https://github.com/drdoctr/doctr/issues">issue
tracker</a>. Issues that are just questions are fine.
</p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, Aaron Meurer and Gil Forsyth.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/commandline.rst.txt"
rel="nofollow">Page source</a>
</div>
<a href="https://github.com/drdoctr/doctr" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>
</body>
</html>