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
|
# Copyright 2016 by Rackspace Hosting, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""RFC extension for Sphinx.
This extensions adds hyperlinking for any RFC references that are
formatted like this::
RFC 7231; Section 6.5.3
"""
import re
RFC_PATTERN = re.compile('RFC (\d{4}), Section ([\d\.]+)')
def _render_section(section_number, rfc_number):
template = '`{0} <https://tools.ietf.org/html/rfc{1}#section-{0}>`_'
return template.format(section_number, rfc_number)
def _process_line(line):
m = RFC_PATTERN.search(line)
if not m:
return line
rfc = m.group(1)
section = m.group(2)
template = (
'`RFC {rfc}, Section {section} '
'<https://tools.ietf.org/html/rfc{rfc}#section-{section}>`_'
)
rendered_text = template.format(rfc=rfc, section=section)
return line[: m.start()] + rendered_text + line[m.end() :]
def _on_process_docstring(app, what, name, obj, options, lines):
"""Process the docstring for a given python object."""
if what == 'module' and name == 'falcon':
lines[:] = []
return
lines[:] = [_process_line(line) for line in lines]
def setup(app):
app.connect('autodoc-process-docstring', _on_process_docstring)
return {'parallel_read_safe': True}
|
