在Sphinx文档中显示字典数据

Question

我在Python项目源代码中有一个字典，描述了默认配置值。字典很长。我想在Sphinx文档中以除“查看源代码”之外的其他格式查看字典，以便人们可以快速检查默认值。

当与Sphinx autodoc一起使用时，Sphinx是否提供选项来格式化类似于字典的变量以实现人类可读的格式？我目前正在使用.. automodule::转储整个模块，并将字典作为文档中的一个长字符串转储（没有换行符，漂亮的打印内容，任何东西）来获取，基本上是不可读的。

• Sphinx是否提供工具来打印出各个源代码变量的值

• 有没有漂亮的印刷品？

Answer 1

这可能不是最优雅的解决方案（最好编写一个正确的指令以输出漂亮的字典），但是现在可以使用：

将此处给出的自定义exec指令添加到您的Sphinx
.conf文件中，然后在要打印字典的.rst文件中，执行以下操作：

.. exec::
    import json
    from some_module import some_dictionary
    json_obj = json.dumps(some_dictionary, sort_keys=True, indent=4)
    print '.. code-block:: JavaScript\n\n    %s\n\n' % json_obj

这将在文档中的JavaScript代码块中打印出字典（我发现这是在文档中呈现词典的最佳方法）。