/usr/share/doc/python-sphinxcontrib.issuetracker/html/configuration.html is in python-sphinxcontrib.issuetracker 0.11-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Configuration — sphinxcontrib-issuetracker 0.11 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/issuetracker.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.11',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sphinxcontrib-issuetracker 0.11 documentation" href="index.html" />
<link rel="next" title="Customization" href="customization.html" />
<link rel="prev" title="Usage and operation" href="usage.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="customization.html" title="Customization"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage and operation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">sphinxcontrib-issuetracker 0.11 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="configuration">
<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="general-configuration">
<h2>General configuration<a class="headerlink" href="#general-configuration" title="Permalink to this headline">¶</a></h2>
<p>Add <tt class="docutils literal"><span class="pre">sphinxcontrib.issuetracker</span></tt> to the configuration value
<tt class="xref std std-confval docutils literal"><span class="pre">extensions</span></tt> to enable this extensions and configure the extension:</p>
<dl class="confval">
<dt id="confval-issuetracker">
<tt class="descname">issuetracker</tt><a class="headerlink" href="#confval-issuetracker" title="Permalink to this definition">¶</a></dt>
<dd><p>The issuetracker to use. As of now, the following trackers are
supported:</p>
<ul>
<li><p class="first"><tt class="docutils literal"><span class="pre">github</span></tt>: The issue tracker of <a class="reference external" href="https://github.com">https://github.com</a>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">bitbucket</span></tt>: The issue tracker of <a class="reference external" href="https://bitbucket.org">https://bitbucket.org</a>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">launchpad</span></tt>: The issue tracker of <a class="reference external" href="https://launchpad.net">https://launchpad.net</a>. To use this
issue tracker, <a class="reference external" href="http://pypi.python.org/pypi/launchpadlib/">launchpadlib</a> must be installed. This tracker is not
supported on Python 3, because <a class="reference external" href="http://pypi.python.org/pypi/launchpadlib/">launchpadlib</a> is not yet available for
Python 3.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">google</span> <span class="pre">code</span></tt>: The issue tracker of <a class="reference external" href="http://code.google.com">http://code.google.com</a>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">debian</span></tt>: The Debian issue tracker at <a class="reference external" href="http://bugs.debian.org">http://bugs.debian.org</a>. To use
this issue tracker, <a class="reference external" href="http://pypi.python.org/pypi/python-debianbts/">debianbts</a> and <a class="reference external" href="http://pypi.python.org/pypi/SOAPpy/">SOAPpy</a> must be installed. This issue
tracker is not available on Python 3, because neither <a class="reference external" href="http://pypi.python.org/pypi/python-debianbts/">debianbts</a> nor
<a class="reference external" href="http://pypi.python.org/pypi/SOAPpy/">SOAPpy</a> are available for Python 3 yet.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">jira</span></tt>: A <a class="reference external" href="http://www.atlassian.com/software/jira/">Jira</a> instance. With this issue tracker
<a class="reference internal" href="#confval-issuetracker_url"><tt class="xref std std-confval docutils literal"><span class="pre">issuetracker_url</span></tt></a> must be set to the base url of the Jira
instance to use. Otherwise a <a class="reference external" href="http://docs.python.org/library/exceptions.html#exceptions.ValueError" title="(in Python v2.7)"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> is raised when
resolving the first issue reference.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.</span></p>
</div>
</li>
</ul>
</dd></dl>
<dl class="confval">
<dt id="confval-issuetracker_project">
<tt class="descname">issuetracker_project</tt><a class="headerlink" href="#confval-issuetracker_project" title="Permalink to this definition">¶</a></dt>
<dd><p>The project inside the issue tracker or the project, to which the issue
tracker belongs. Defaults to the value of <tt class="xref std std-confval docutils literal"><span class="pre">project</span></tt>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In case of BitBucket and GitHub, the project name must include the name
of the user or organization, the project belongs to. For instance, the
project name of <a class="reference external" href="http://sphinx.pocoo.org">Sphinx</a> itself is not just <tt class="docutils literal"><span class="pre">sphinx</span></tt>, but
<tt class="docutils literal"><span class="pre">birkenfeld/sphinx</span></tt> instead. If the user name is missing, a
<a class="reference external" href="http://docs.python.org/library/exceptions.html#exceptions.ValueError" title="(in Python v2.7)"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> will be raised when an issue is to be
resolved the first time.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 0.8: </span>Project names must include the user name now.</p>
</div>
</dd></dl>
<dl class="confval">
<dt id="confval-issuetracker_url">
<tt class="descname">issuetracker_url</tt><a class="headerlink" href="#confval-issuetracker_url" title="Permalink to this definition">¶</a></dt>
<dd><p>The base url of the issue tracker:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">issuetracker</span> <span class="o">=</span> <span class="s">'jira'</span>
<span class="n">issuetracker_url</span> <span class="o">=</span> <span class="s">'https://studio.atlassian.com'</span>
</pre></div>
</div>
<p>Required by all issue trackers which do not only have a single instance, but
many different instances on many different sites.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.</span></p>
</div>
</dd></dl>
</div>
<div class="section" id="plaintext-issues">
<h2>Plaintext issues<a class="headerlink" href="#plaintext-issues" title="Permalink to this headline">¶</a></h2>
<dl class="confval">
<dt id="confval-issuetracker_plaintext_issues">
<tt class="descname">issuetracker_plaintext_issues</tt><a class="headerlink" href="#confval-issuetracker_plaintext_issues" title="Permalink to this definition">¶</a></dt>
<dd><p>If <tt class="docutils literal"><span class="pre">True</span></tt> (the default) issue references are extracted from plain text by
turning issue ids like <tt class="docutils literal"><span class="pre">#10</span></tt> into references to the corresponding issue.
Issue ids in any kind of literal text (e.g. <tt class="docutils literal"><span class="pre">inline</span> <span class="pre">literals</span></tt> or code
blocks) are ignored. If <tt class="docutils literal"><span class="pre">False</span></tt>, no issue references are created from
plain text.</p>
<p>Independently of this configuration value, you can always reference issues
explicitly with the <a class="reference internal" href="usage.html#role-issue" title="issue role"><tt class="xref rst rst-role docutils literal"><span class="pre">issue</span></tt></a> role.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.9.</span></p>
</div>
</dd></dl>
<p>By default the extension looks for issue references starting with a single
dash, like <tt class="docutils literal"><span class="pre">#10</span></tt>. You can however change the pattern, which is used to
find issue references:</p>
<dl class="confval">
<dt id="confval-issuetracker_issue_pattern">
<tt class="descname">issuetracker_issue_pattern</tt><a class="headerlink" href="#confval-issuetracker_issue_pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>A regular expression, which is used to find and parse issue references.
Defaults to <tt class="docutils literal"><span class="pre">r'#(\d+)'</span></tt>. If changed to <tt class="docutils literal"><span class="pre">r'gh-(\d+)'</span></tt> for instance,
this extension would not longer recognize references like <tt class="docutils literal"><span class="pre">#10</span></tt>, but
instead parse references like <tt class="docutils literal"><span class="pre">gh-10</span></tt>. The pattern must contain only a
single group, which matches the issue id.</p>
</dd></dl>
<p>Normally the reference title will be the whole issue id. However you can also
use a custom reference title:</p>
<dl class="confval">
<dt id="confval-issuetracker_title_template">
<tt class="descname">issuetracker_title_template</tt><a class="headerlink" href="#confval-issuetracker_title_template" title="Permalink to this definition">¶</a></dt>
<dd><p>A <a class="reference external" href="http://docs.python.org/library/string.html#format-string-syntax">format string</a> template for the title of references created from
plaintext issue ids. The format string gets the <tt class="xref py py-class docutils literal"><span class="pre">Issue</span></tt> object
corresponding to the referenced issue in the <tt class="docutils literal"><span class="pre">issue</span></tt> key, you may use any
attributes of this object in your format string. You can for instance
include the issue title and the issue id:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">issuetracker_title_template</span> <span class="o">=</span> <span class="s">'{issue.title} ({issue.id})'</span>
</pre></div>
</div>
<p>If unset, the whole text matched by <a class="reference internal" href="#confval-issuetracker_issue_pattern"><tt class="xref std std-confval docutils literal"><span class="pre">issuetracker_issue_pattern</span></tt></a> is
used as reference title.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.9: </span>Replaces <tt class="xref std std-confval docutils literal"><span class="pre">issuetracker_expandtitle</span></tt></p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Configuration</a><ul>
<li><a class="reference internal" href="#general-configuration">General configuration</a></li>
<li><a class="reference internal" href="#plaintext-issues">Plaintext issues</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="usage.html"
title="previous chapter">Usage and operation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="customization.html"
title="next chapter">Customization</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/configuration.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="customization.html" title="Customization"
>next</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage and operation"
>previous</a> |</li>
<li><a href="index.html">sphinxcontrib-issuetracker 0.11 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, 2011, 2012 Sebastian Wiesner.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|