diff options
Diffstat (limited to 'numpy/doc/constants.py')
| -rw-r--r-- | numpy/doc/constants.py | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/numpy/doc/constants.py b/numpy/doc/constants.py index 7a9105667..2e30374fb 100644 --- a/numpy/doc/constants.py +++ b/numpy/doc/constants.py @@ -7,7 +7,10 @@ Numpy includes several constants: %(constant_list)s """ -import textwrap +# +# Note: the docstring is autogenerated. +# +import textwrap, re # Maintain same format as in numpy.add_newdocs constants = [] @@ -362,8 +365,23 @@ if __doc__: constants_str = [] constants.sort() for name, doc in constants: - constants_str.append(""".. const:: %s\n %s""" % ( - name, textwrap.dedent(doc).replace("\n", "\n "))) + s = textwrap.dedent(doc).replace("\n", "\n ") + + # Replace sections by rubrics + lines = s.split("\n") + new_lines = [] + for line in lines: + m = re.match(r'^(\s+)[-=]+\s*$', line) + if m and new_lines: + prev = textwrap.dedent(new_lines.pop()) + new_lines.append('%s.. rubric:: %s' % (m.group(1), prev)) + new_lines.append('') + else: + new_lines.append(line) + s = "\n".join(new_lines) + + # Done. + constants_str.append(""".. const:: %s\n %s""" % (name, s)) constants_str = "\n".join(constants_str) __doc__ = __doc__ % dict(constant_list=constants_str) |