commit ced78f5803c3cb74f4eacc0bfef0596ee6f385f1 Author: Damian Johnson atagar@torproject.org Date: Sun Aug 16 00:38:53 2020 -0700
Simplify Sphinx roles
Originally we added roles based on a tutorial from...
https://trac.torproject.org/projects/tor/ticket/8671
This was a lot more verbose than it needs to be. Trimming these to the simplest functions I can come up with. --- docs/conf.py | 3 --- docs/roles.py | 78 +++++++++++++---------------------------------------------- 2 files changed, 17 insertions(+), 64 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py index f9aa73fc..b7b21fe4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -286,9 +286,6 @@ man_pages = [ ['%s (%s)' % (__author__, __contact__)], 1) ]
-trac_url = 'https://trac.torproject.org/%7Bslug%7D' -spec_url = 'https://gitweb.torproject.org/torspec.git/commit/?id=%7Bslug%7D' -
def skip_members(app, what, name, obj, skip, options): if name in ('ATTRIBUTES', 'PARSER_FOR_LINE'): diff --git a/docs/roles.py b/docs/roles.py index 27b4d4a9..fcec7e9d 100644 --- a/docs/roles.py +++ b/docs/roles.py @@ -4,85 +4,44 @@ from docutils.utils import unescape from docutils.nodes import reference from docutils.parsers.rst.roles import set_classes
+TRAC_URL = 'https://trac.torproject.org/%7Bticket%7D' +SPEC_URL = 'https://gitweb.torproject.org/torspec.git/commit/?id=%7Bcommit%7D'
-def role_trac(name, rawtext, text, lineno, inliner, options={}, content=[]): + +def role_trac(name, rawtext, argument, lineno, inliner, options = {}, content = []): """ Aliases :trac:`1234` to 'https://trac.torproject.org/1234'. - - :param name: the role name used in the document - :param rawtext: the entire markup snippet, with role - :param text: the text marked with the role - :param lineno: the line number where rawtext appears in the input - :param inliner: the inliner instance that called us - :param options: directive options for customization - :param content: the directive content for customization """
- # checking if the number is valid - try: - ticket_num = int(text) - - if ticket_num <= 0: - raise ValueError - except ValueError: - msg = inliner.reporter.error('Invalid trac ticket: %s' % text, line=lineno) - prb = inliner.problematic(rawtext, rawtext, msg) - - return ([prb], [msg]) - - app = inliner.document.settings.env.app - link_text = 'ticket %s' % unescape(str(ticket_num)) + if not argument.isdigit() or int(argument) <= 0: + return ( + [inliner.problematic(rawtext, rawtext, msg)], + [inliner.reporter.error('Invalid trac ticket: %s' % argument, line = lineno)], + )
return ( - [make_link_node(rawtext, app, 'trac_url', link_text, str(ticket_num), options)], + [reference(rawtext, 'ticket %s' % argument, refuri = TRAC_URL.format(ticket = argument), **options)], [], )
-def role_spec(name, rawtext, text, lineno, inliner, options={}, content=[]): +def role_spec(name, rawtext, argument, lineno, inliner, options = {}, content = []): """ Aliases :spec:`25b0d43` to 'https://gitweb.torproject.org/torspec.git/commit/?id=25b0d43'. """
- # checking if the input is a valid short commit id - - if not re.match('^[0-9a-f]{7}$', text): - msg = inliner.reporter.error('Spec tag expects a short commit id (seven hex characters): %s' % text, line=lineno) - prb = inliner.problematic(rawtext, rawtext, msg) - - return ([prb], [msg]) - - app = inliner.document.settings.env.app + if not re.match('^[0-9a-f]{7}$', argument): + return ( + [inliner.problematic(rawtext, rawtext, msg)], + [inliner.reporter.error('Spec tag expects a short commit id (seven hex characters): %s' % argument, line = lineno)], + )
return ( - [make_link_node(rawtext, app, 'spec_url', 'spec', text, options)], + [reference(rawtext, 'spec', refuri = SPEC_URL.format(commit = argument), **options)], [], )
-def make_link_node(rawtext, app, url_type, link_text, slug, options): - """ - Creates a link to a trac ticket. - - :param rawtext: text being replaced with link node - :param app: sphinx application context - :param url_type: base for our url - :param link_text: text for the link - :param slug: ID of the thing to link to - :param options: options dictionary passed to role func - """ - - base_url = getattr(app.config, url_type, None) - - if not base_url: - raise ValueError("'%s' isn't set in our config" % url_type) - - ref = base_url.format(slug = slug) - set_classes(options) - - return reference(rawtext, link_text, refuri = ref, **options) - - def setup(app): """ Installs the plugin. @@ -91,7 +50,4 @@ def setup(app): """
app.add_role('trac', role_trac) - app.add_config_value('trac_url', None, 'env') - app.add_role('spec', role_spec) - app.add_config_value('spec_url', None, 'env')