forked from pantsbuild/pantsbuild.github.io
/
page.html
489 lines (460 loc) · 26.1 KB
/
page.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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<!DOCTYPE html>
<html lang="en">
<!--
Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
Licensed under the Apache License, Version 2.0 (see LICENSE).
-->
<head>
<meta charset="utf-8"/>
<title>Markdown</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="pants-logo.ico">
<!-- In case this is a "test publish", tell search engines where real version lives: -->
<link rel="canonical" href="http://pantsbuild.org/page.html">
<link rel="stylesheet" href="bootstrap-custom.min.css">
<link rel="stylesheet" href="bootstrap-custom-theme.min.css">
<link rel="stylesheet" href="docsite.css">
</head>
<body>
<div class="header">
<nav class="navbar navbar-default navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-img" href="index.html">
<img src="pants-logo.ico" alt="[pantsbuild logo]">
</a>
<a class="navbar-brand" href="index.html">
Pants
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="/">Docs</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="https://www.github.com/pantsbuild/pants">GitHub</a></li>
<li>
<form class="navbar-form navbar-left search" role="search" action="https://www.google.com/search">
<div class="form-group">
<input type="text" name="as_q" class="form-control query" placeholder="Search">
<input name="as_sitesearch" value="pantsbuild.org" type="hidden">
</div>
</form>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="page">
<div class="container-fluid">
<div class="row">
<div class="col-md-1">
</div>
<div class="col-md-2">
<div class="site-toc">
<ul>
<li class="toc-h1 toc-heading">
Getting Started
</li>
<li class="toc-h1 toc-link ">
<a href="install.html">Installing Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="setup_repo.html">Setting Up Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_tutorial.html">Tutorial</a>
</li>
<li class="toc-h1 toc-link ">
<a href="common_tasks.html">Common Tasks</a>
</li>
<li class="toc-h1 toc-heading">
Pants Basics
</li>
<li class="toc-h1 toc-link ">
<a href="why_use_pants.html">Why Use Pants?</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_concepts.html">Pants Concepts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="build_files.html">BUILD files</a>
</li>
<li class="toc-h1 toc-link ">
<a href="target_addresses.html">Target Addresses</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty.html">Third-Party Dependencies</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options.html">Pants Options</a>
</li>
<li class="toc-h1 toc-link ">
<a href="invoking.html">Invoking Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="reporting_server.html">Reporting Server</a>
</li>
<li class="toc-h1 toc-link ">
<a href="ide_support.html">IDE Support</a>
</li>
<li class="toc-h1 toc-heading">
JVM
</li>
<li class="toc-h1 toc-link ">
<a href="jvm_projects.html">JVM Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_jvm.html">JVM 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-link ">
<a href="scala.html">Scala Support</a>
</li>
<li class="toc-h1 toc-link ">
<a href="publish.html">Publishing Artifacts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="from_maven.html">Pants for Maven Experts</a>
</li>
<li class="toc-h1 toc-heading">
Python
</li>
<li class="toc-h1 toc-link ">
<a href="python_readme.html">Python Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_py.html">Python 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-heading">
Go
</li>
<li class="toc-h1 toc-link ">
<a href="go_readme.html">Go support for Pants</a>
</li>
<li class="toc-h1 toc-heading">
Codegen
</li>
<li class="toc-h1 toc-link ">
<a href="thrift_deps.html">Thrift</a>
</li>
<li class="toc-h1 toc-heading">
Docgen
</li>
<li class="toc-h1 toc-link toc-here">
Markdown
</li>
<li class="toc-h1 toc-heading">
Getting Help
</li>
<li class="toc-h1 toc-link ">
<a href="tshoot.html">Troubleshooting</a>
</li>
<li class="toc-h1 toc-link ">
<a href="community.html">Community</a>
</li>
<li class="toc-h1 toc-heading">
Reference
</li>
<li class="toc-h1 toc-link ">
<a href="build_dictionary.html">Pants BUILD Dictionary</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options_reference.html">Pants Reference</a>
</li>
<li class="toc-h1 toc-heading">
Release Notes
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.3.x.html">1.3.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.2.x.html">1.2.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.1.x.html">1.1.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.0.x.html">1.0.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-master.html">Master Pre-Releases</a>
</li>
<li class="toc-h1 toc-heading">
Developer
</li>
<li class="toc-h1 toc-link ">
<a href="dev.html">Pants Developer Center</a>
</li>
<li class="toc-h1 toc-link ">
<a href="export.html">Export Format</a>
</li>
</ul>
</div> <!-- site-toc -->
</div>
<div class="col-md-8">
<div class="content">
<div class="mainflow">
<nav class="pagetoc">
<ul>
<li class="toc-h1"><a href="#markdown-to-html">Markdown to HTML</a></li>
<li class="toc-h1"><a href="#markdown-syntax">Markdown Syntax</a></li>
<li class="toc-h2"><a href="#link-to-another-page">Link to Another page</a></li>
<li class="toc-h2"><a href="#include-a-file-snippet">Include a File Snippet</a></li>
<li class="toc-h1"><a href="#restructedtext-syntax">ReStructedText Syntax</a></li>
<li class="toc-h1"><a href="#publishing">Publishing</a></li>
</ul>
</nav>
<!-- main content start -->
<!-- generated by pants! -->
<style>
.codehilite .hll { background-color: #ffffcc }
.codehilite { background: #f0f0f0; }
.codehilite .c { color: #60a0b0; font-style: italic } /* Comment */
.codehilite .err { border: 1px solid #FF0000 } /* Error */
.codehilite .k { color: #007020; font-weight: bold } /* Keyword */
.codehilite .o { color: #666666 } /* Operator */
.codehilite .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.codehilite .cp { color: #007020 } /* Comment.Preproc */
.codehilite .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.codehilite .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.codehilite .gd { color: #A00000 } /* Generic.Deleted */
.codehilite .ge { font-style: italic } /* Generic.Emph */
.codehilite .gr { color: #FF0000 } /* Generic.Error */
.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.codehilite .gi { color: #00A000 } /* Generic.Inserted */
.codehilite .go { color: #808080 } /* Generic.Output */
.codehilite .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.codehilite .gs { font-weight: bold } /* Generic.Strong */
.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.codehilite .gt { color: #0040D0 } /* Generic.Traceback */
.codehilite .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.codehilite .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.codehilite .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.codehilite .kp { color: #007020 } /* Keyword.Pseudo */
.codehilite .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.codehilite .kt { color: #902000 } /* Keyword.Type */
.codehilite .m { color: #40a070 } /* Literal.Number */
.codehilite .s { color: #4070a0 } /* Literal.String */
.codehilite .na { color: #4070a0 } /* Name.Attribute */
.codehilite .nb { color: #007020 } /* Name.Builtin */
.codehilite .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.codehilite .no { color: #60add5 } /* Name.Constant */
.codehilite .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.codehilite .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.codehilite .ne { color: #007020 } /* Name.Exception */
.codehilite .nf { color: #06287e } /* Name.Function */
.codehilite .nl { color: #002070; font-weight: bold } /* Name.Label */
.codehilite .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.codehilite .nt { color: #062873; font-weight: bold } /* Name.Tag */
.codehilite .nv { color: #bb60d5 } /* Name.Variable */
.codehilite .ow { color: #007020; font-weight: bold } /* Operator.Word */
.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
.codehilite .mf { color: #40a070 } /* Literal.Number.Float */
.codehilite .mh { color: #40a070 } /* Literal.Number.Hex */
.codehilite .mi { color: #40a070 } /* Literal.Number.Integer */
.codehilite .mo { color: #40a070 } /* Literal.Number.Oct */
.codehilite .sb { color: #4070a0 } /* Literal.String.Backtick */
.codehilite .sc { color: #4070a0 } /* Literal.String.Char */
.codehilite .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.codehilite .s2 { color: #4070a0 } /* Literal.String.Double */
.codehilite .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.codehilite .sh { color: #4070a0 } /* Literal.String.Heredoc */
.codehilite .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.codehilite .sx { color: #c65d09 } /* Literal.String.Other */
.codehilite .sr { color: #235388 } /* Literal.String.Regex */
.codehilite .s1 { color: #4070a0 } /* Literal.String.Single */
.codehilite .ss { color: #517918 } /* Literal.String.Symbol */
.codehilite .bp { color: #007020 } /* Name.Builtin.Pseudo */
.codehilite .vc { color: #bb60d5 } /* Name.Variable.Class */
.codehilite .vg { color: #bb60d5 } /* Name.Variable.Global */
.codehilite .vi { color: #bb60d5 } /* Name.Variable.Instance */
.codehilite .il { color: #40a070 } /* Literal.Number.Integer.Long */
</style>
<h1 id="markdown">Markdown</h1>
<p>You can write codebase documentation in the popular Markdown or ReST format;
Pants eases generating readable versions and publishing them so your users can read it.</p>
<h2 id="markdown-to-html">Markdown to HTML</h2>
<p>To tell Pants about your Markdown or ReST file, use a
<a href="build_dictionary.html#bdict_page" pantsref="bdict_page"><code>page</code></a>
target in a <code>BUILD</code> file as in this excerpt from
<a href="https://github.com/pantsbuild/pants/blob/master/examples/src/java/org/pantsbuild/example/hello/main/BUILD">examples/src/java/org/pantsbuild/example/hello/main/BUILD</a>:</p>
<p>
<div class="md-included-snippet"><div class="codehilite"><pre><span class="n">page</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"readme"</span><span class="p">,</span>
<span class="n">source</span><span class="o">=</span><span class="s">"README.md"</span><span class="p">)</span>
</pre></div></div>
</p>
<p>To render the page as HTML, use the
<a href="options_reference.html#oref_goal_markdown" pantsref="oref_goal_markdown">markdown goal</a>. For example, to view
<code>examples/src/java/org/pantsbuild/example/hello/main/README.md</code> as HTML in
your browser,</p>
<div class="codehilite"><pre><span class="nv">$ </span>./pants markdown --open examples/src/java/org/pantsbuild/example/hello/main:readme
</pre></div>
<p>Pants generates the HTML files in the <code>dist/markdown/</code> directory tree.</p>
<h2 id="markdown-syntax">Markdown Syntax</h2>
<p>Pants uses the Python <code>Markdown</code> module; thus, in addition to the usual
Gruber <code>Markdown</code> syntax, there are <a href="http://pythonhosted.org/Markdown/">other
features</a> Pants uses Python
Markdown's <code>codehilite</code>, <code>extra</code>, <code>tables</code>, and <code>toc</code> extensions.</p>
<h3 id="link-to-another-page">Link to Another <code>page</code></h3>
<p>One <code>page</code> can link to another. Regular Markdown-link syntax works for
regular links; but if you use <code>page</code>s to generate both <code>.html</code> files and
wiki pages, it's not clear what to link to: the <code>.html</code> file or the wiki
address. You can use a Pants-specific syntax to make links that work
with generated HTML or wiki pages.</p>
<p>To set up a page <code>source.md</code> that contains a link to <code>dest.md</code>, you make
a <code>dependencies</code> relation and use the special <code>pants(...)</code> syntax in the
markdown.</p>
<p>In the <code>BUILD</code> file:</p>
<div class="codehilite"><pre><span class="n">page</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'source'</span><span class="p">,</span>
<span class="n">source</span><span class="o">=</span><span class="s">'source.md'</span><span class="p">,</span>
<span class="n">dependencies</span><span class="o">=</span><span class="p">[</span><span class="s">':dest'</span><span class="p">],</span> <span class="c"># enables linking</span>
<span class="n">provides</span><span class="o">=</span><span class="p">[</span><span class="o">...</span><span class="n">publishing</span> <span class="n">info</span><span class="o">...</span><span class="p">],</span>
<span class="p">)</span>
<span class="n">page</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'dest'</span><span class="p">,</span>
<span class="n">source</span><span class="o">=</span><span class="s">'dest.md'</span><span class="p">,</span>
<span class="n">provides</span><span class="o">=</span><span class="p">[</span><span class="o">...</span><span class="n">publishing</span> <span class="n">info</span><span class="o">...</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
<p>To set up the links in <code>source.md</code> that point to <code>dest.md</code> or an anchor
therein:</p>
<div class="codehilite"><pre>For more information about this fascinating topic,
please see [[Destinations|pants('path/to:dest')]],
especially the
[[Addendum section|pants('path/to:dest)'#addendum]],
</pre></div>
<p>Pants replaces the <code>pants('path/to:dest')</code> with the appropriate link.</p>
<h3 id="include-a-file-snippet">Include a File Snippet</h3>
<p>Sometimes the best way to explain <code>HelloWorld.java</code> is to show an
excerpt from <code>HelloWorld.java</code>. You can use the <code>!inc</code> markdown to do
this. Specify a file to include and (optionally) regexps at which to
start copying or stop copying. For example, to include an excerpt from
the file <code>HelloMain.java</code>, starting with the first line matching the
pattern <code>void main</code> and stopping before a subsequent line matching
<code>private HelloMain</code>:</p>
<div class="codehilite"><pre>!inc[start-at=void main&end-before=private HelloMain](HelloMain.java)
</pre></div>
<p>To include <em>all</em> of <code>HelloMain.java</code>:</p>
<div class="codehilite"><pre>!inc(HelloMain.java)
</pre></div>
<p>To include most of <code>HelloMain.java</code>, starting after license boilerplate:</p>
<div class="codehilite"><pre>!inc[start-after=Licensed under the Apache](HelloMain.java)
</pre></div>
<p>It accepts the following optional parameters, separated by ampersands
(&):</p>
<p>start-at=<em>substring</em><br>
When excerpting the file to include, start at the first line containing
<em>substring</em>.</br></p>
<p>start-after=<em>substring</em><br>
When excerpting the file to include, start after the first line
containing <em>substring</em>.</br></p>
<p>end-before=<em>substring</em><br>
When excerpting the file to include, stop before a line containing
<em>substring</em>.</br></p>
<p>end-at=<em>substring</em><br>
When excerpting the file to include, stop at a line containing
<em>substring</em>.</br></p>
<h2 id="restructedtext-syntax">ReStructedText Syntax</h2>
<p>Pants can generate web content from
<a href="http://docutils.sourceforge.net/rst.html">docutils reStructuredText</a>-formatted text.</p>
<p>To tell Pants that your <code>page</code> target's source is in reStructuredText format, you can either</p>
<ul>
<li>give the <code>source</code> file an <code>.rst</code> file extension, or</li>
<li>pass <code>format='rst'</code> to the <code>page</code> target.</li>
</ul>
<h2 id="publishing">Publishing</h2>
<p>You can tell Pants to publish a page. So far, there's only one way to
publish: as a page in an Atlassian Confluence wiki. (You can add other
doc-publish backends to Pants;
<a href="howto_contribute.html">send us a patch</a>!)</p>
<p>To specify the "address" to which to publish a page, give it a
<code>provides</code> parameter.</p>
<p>Once you've done this, you can publish the page by invoking the goal
<a href="page.html#page_setup_confluence" pantsref="page_setup_confluence">set up in your workspace</a>. For example, if
the goal was set up with the name "confluence", you invoke:</p>
<div class="codehilite"><pre><span class="nv">$ </span>./pants confluence examples/src/java/org/pantsbuild/example/hello/main:readme
</pre></div>
<p>To specify that a page should be published to a Confluence wiki page,
set its <code>provides</code> to something like:</p>
<div class="codehilite"><pre><span class="n">page</span><span class="p">(</span><span class="o">...</span>
<span class="n">provides</span><span class="o">=</span><span class="p">[</span>
<span class="n">wiki_artifact</span><span class="p">(</span><span class="n">wiki</span><span class="o">=</span><span class="n">confluence</span><span class="p">,</span>
<span class="n">space</span><span class="o">=</span><span class="s">'ENG'</span><span class="p">,</span>
<span class="n">title</span><span class="o">=</span><span class="s">'Pants Hello World Example'</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="s">'Examples'</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">],)</span>
</pre></div>
<p>...assuming your workspace is set up for confluence publishing with a <code>Wiki</code> symbol named
<code>confluence</code> set up as part of a plugin as described below:</p>
<p><a id="page_setup_confluence" pantsmark="page_setup_confluence"></a></p>
<p><strong>Setting up your workspace for Confluence publish</strong></p>
<p>That <code>wiki</code> specifies some information about your wiki server. So far, the only kind of thing you
can publish to is a Confluence wiki. To set up and register this symbol, set up a
<a href="howto_plugin.html">Pants plugin</a> if your workspace doesn't already
have one. In the plugin, define a <code>Wiki</code> and register it:</p>
<div class="codehilite"><pre><span class="kn">import</span> <span class="nn">urllib</span>
<span class="kn">from</span> <span class="nn">pants.backend.docgen.targets.doc</span> <span class="kn">import</span> <span class="n">Wiki</span>
<span class="k">def</span> <span class="nf">confluence_url_builder</span><span class="p">(</span><span class="n">page</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s">'title'</span><span class="p">]</span>
<span class="k">return</span> <span class="n">title</span><span class="p">,</span> <span class="s">'https://wiki.archie.org/display/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">config</span><span class="p">[</span><span class="s">'space'</span><span class="p">],</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
<span class="n">confluence_wiki</span> <span class="o">=</span> <span class="n">Wiki</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'confluence'</span><span class="p">,</span> <span class="n">url_builder</span><span class="o">=</span><span class="n">confluence_url_builder</span><span class="p">)</span>
<span class="c"># in register.py:</span>
<span class="k">def</span> <span class="nf">build_file_aliases</span><span class="p">():</span>
<span class="k">return</span> <span class="n">BuildFileAliases</span><span class="p">(</span>
<span class="c"># ...</span>
<span class="n">objects</span><span class="o">=</span><span class="p">{</span>
<span class="c"># ...</span>
<span class="s">'confluence'</span><span class="p">,</span> <span class="n">confluence_wiki</span><span class="p">},</span>
<span class="p">)</span>
</pre></div>
<p>You need to install a goal to enable publishing a doc to confluence. To do this, in your Pants
plugin, install a goal that subclasses <code>ConfluencePublish</code>:</p>
<div class="codehilite"><pre><span class="kn">from</span> <span class="nn">pants.backend.docgen.tasks.confluence_publish</span> <span class="kn">import</span> <span class="n">ConfluencePublish</span>
<span class="k">class</span> <span class="nc">ArchieConfluence</span><span class="p">(</span><span class="n">ConfluencePublish</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">wiki</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">confluence_wiki</span>
<span class="k">def</span> <span class="nf">api</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'confluence2'</span>
<span class="c"># in register.py:</span>
<span class="k">def</span> <span class="nf">register_goals</span><span class="p">():</span>
<span class="c"># ...</span>
<span class="n">task</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'confluence'</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="n">ArchieConfluence</span><span class="p">,</span> <span class="n">dependencies</span><span class="o">=</span><span class="p">[</span><span class="s">'markdown'</span><span class="p">])</span><span class="o">.</span><span class="n">install</span><span class="p">()</span>
</pre></div>
<p>In your <code>pants.ini</code> file, add a section with the url of your wiki server. E.g., if your server
is at wiki.archie.org, it would look like:</p>
<div class="codehilite"><pre>[confluence]
url: https://wiki.archie.org
</pre></div>
<!-- main content end -->
<div class="generated">
Generated by <a href="docs.html">publish_docs</a>
from dist/markdown/html/examples/src/java/org/pantsbuild/example/page.html 2017-05-29T10:30:52.175651
</div>
</div> <!-- mainflow -->
</div> <!-- content -->
</div>
<div class="col-md-1">
</div>
</div> <!-- row -->
</div> <!-- container-fluid -->
</div> <!-- page -->
<script src="https://code.jquery.com/jquery-2.2.3.min.js" integrity="sha384-I6F5OKECLVtK/BL+8iSLDEHowSAfUo76ZL9+kGAgTRdiByINKJaqTPH/QVNS1VDb" crossorigin="anonymous"></script>
<script src="bootstrap-custom.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-78111411-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>