API reference

Autolinking extension for Sphinx.

linkify_issues.DEFAULT_ISSUE_RE = '#(?P<issue_id>\\d+)'
data
data
linkify_issues.DEFAULT_ISSUE_RE = '#(?P<issue_id>\\d+)'

Default pattern to search plain nodes for issues.

class linkify_issues.LinkifyIssues
class[source]
class[source]
class linkify_issues.LinkifyIssues

Bases: SphinxTransform

Autolink references for Sphinx.

default_priority = 999
attribute
attribute
default_priority = 999

Numerical priority of this transform, 0 through 999 (override).

apply()
method[source]
method[source]
apply()

Apply Sphinx transform.

Return type:

None

class linkify_issues.SetupDict
class[source]
class[source]
class linkify_issues.SetupDict

Bases: TypedDict

Setup mapping for Sphinx app.

version: str
attribute
attribute
version: str
parallel_read_safe: bool
attribute
attribute
parallel_read_safe: bool
parallel_write_safe: bool
attribute
attribute
parallel_write_safe: bool
linkify_issues.setup(app)
function[source]
function[source]
linkify_issues.setup(app)

Initialize Sphinx extension for linkify_issues.

Parameters:

app (Sphinx)

Return type:

SetupDict