mirror of
https://github.com/WeblateOrg/weblate.git
synced 2026-07-27 20:34:51 +08:00
1826011030
These are easier to understand when reading the code. The feature is in preview mode since ruff 0.15.17.
92 lines
2.9 KiB
Python
Vendored
92 lines
2.9 KiB
Python
Vendored
# Copyright © Michal Čihař <michal@weblate.org>
|
|
#
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
"""Sphinx plugins for Weblate documentation."""
|
|
|
|
import re
|
|
from urllib.parse import quote
|
|
|
|
from docutils import nodes
|
|
from docutils.nodes import literal
|
|
from sphinx import addnodes
|
|
from sphinx.domains.std import Cmdoption
|
|
from sphinx.util.nodes import split_explicit_title
|
|
|
|
# RE for option descriptions without a '--' prefix
|
|
simple_option_desc_re = re.compile(r"([-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)")
|
|
|
|
GHSSA_URL = "https://github.com/WeblateOrg/weblate/security/advisories/{}"
|
|
PYPI_URL = "https://pypi.org/project/{}/"
|
|
|
|
|
|
class WeblateCommandLiteral(literal):
|
|
def __init__(self, rawsource="", text="", *children, **attributes) -> None:
|
|
if not text:
|
|
text = "weblate "
|
|
super().__init__(rawsource, text, *children, **attributes)
|
|
|
|
|
|
# ruff: ignore[mutable-argument-default]
|
|
def ghsa_link(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
|
fullname = f"GHSA-{text}"
|
|
url = GHSSA_URL.format(fullname)
|
|
node = nodes.reference(rawtext, fullname, refuri=url, **options)
|
|
return [node], []
|
|
|
|
|
|
def pypi_link(name, rawtext, text, lineno, inliner, options=None, content=None):
|
|
options = options or {}
|
|
has_explicit_title, title, target = split_explicit_title(text)
|
|
package = target.strip()
|
|
title = title.strip() if has_explicit_title else package
|
|
if not package:
|
|
msg = inliner.reporter.error("PyPI package name is empty", line=lineno)
|
|
return [inliner.problematic(rawtext, rawtext, msg)], [msg]
|
|
node = nodes.reference(
|
|
rawtext, title, refuri=PYPI_URL.format(quote(package, safe="")), **options
|
|
)
|
|
return [node], []
|
|
|
|
|
|
def setup(app) -> None:
|
|
app.add_crossref_type(
|
|
directivename="setting", rolename="setting", indextemplate="pair: %s; setting"
|
|
)
|
|
app.add_object_type(
|
|
directivename="weblate-admin",
|
|
rolename="wladmin",
|
|
indextemplate="pair: %s; weblate admin command",
|
|
parse_node=parse_weblate_admin_node,
|
|
ref_nodeclass=WeblateCommandLiteral,
|
|
)
|
|
app.add_directive("weblate-admin-option", Cmdoption)
|
|
app.add_object_type(
|
|
directivename="django-admin",
|
|
rolename="djadmin",
|
|
indextemplate="pair: %s; django-admin command",
|
|
parse_node=parse_django_admin_node,
|
|
)
|
|
app.add_role("ghsa", ghsa_link)
|
|
app.add_role("pypi", pypi_link)
|
|
return {
|
|
"parallel_read_safe": True,
|
|
"parallel_write_safe": True,
|
|
}
|
|
|
|
|
|
def parse_weblate_admin_node(env, sig, signode):
|
|
command = sig.split(" ")[0]
|
|
# Context for options
|
|
env.ref_context["std:program"] = command
|
|
title = f"weblate {sig}"
|
|
signode += addnodes.desc_name(title, title)
|
|
return command
|
|
|
|
|
|
def parse_django_admin_node(env, sig, signode):
|
|
command = sig.split(" ")[0]
|
|
env.ref_context["std:program"] = command
|
|
title = f"django-admin {sig}"
|
|
signode += addnodes.desc_name(title, title)
|
|
return command
|
