Sphinx文档中的人类可读迭代 [英] Human readable iterables in Sphinx documentation
本文介绍了Sphinx文档中的人类可读迭代的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
Sphinx-autodoc展平字典,列表和元组-使长的几乎不可读。也不总是希望使用漂亮的打印格式,因为某些嵌套容器最好保持扁平而不是成列。
Sphinx-autodoc flattens dicts, lists, and tuples - making long ones barely readable. Pretty-print format isn't always desired either, as some nested containers are better kept flattened than columned. Is there a way to display iterables as typed in source code?
推荐答案
直接从源代码获取它吗? ,并为其添加 .rst
命令:
Get it straight from source, and add an .rst
command for it:
# conf.py
from importlib import import_module
from docutils import nodes
from sphinx import addnodes
from inspect import getsource
from docutils.parsers.rst import Directive
class PrettyPrintIterable(Directive):
required_arguments = 1
def run(self):
def _get_iter_source(src, varname):
# 1. identifies target iterable by variable name, (cannot be spaced)
# 2. determines iter source code start & end by tracking brackets
# 3. returns source code between found start & end
start = end = None
open_brackets = closed_brackets = 0
for i, line in enumerate(src):
if line.startswith(varname):
if start is None:
start = i
if start is not None:
open_brackets += sum(line.count(b) for b in "([{")
closed_brackets += sum(line.count(b) for b in ")]}")
if open_brackets > 0 and (open_brackets - closed_brackets == 0):
end = i + 1
break
return '\n'.join(src[start:end])
module_path, member_name = self.arguments[0].rsplit('.', 1)
src = getsource(import_module(module_path)).split('\n')
code = _get_iter_source(src, member_name)
literal = nodes.literal_block(code, code)
literal['language'] = 'python'
return [addnodes.desc_name(text=member_name),
addnodes.desc_content('', literal)]
def setup(app):
app.add_directive('pprint', PrettyPrintIterable)
示例.rst和结果:
< a href = https://i.stack.imgur.com/qxoJV.png rel = nofollow noreferrer>
(:autodata:
为空,:注释:
是排除原始拼合的字典)。
(:autodata:
with empty :annotation:
is to exclude the original flattened dictionary).
从此答案。
这篇关于Sphinx文档中的人类可读迭代的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!
查看全文