sphinx.ext.viewcode --添加指向突出显示的源代码的链接¶
模块作者： Georg Brandl
Added in version 1.0.
此扩展查看您的python对象描述 (.. class:: ， .. function:: 等）并尝试查找包含对象的源文件。找到后，将为每个模块输出一个单独的HTML页面，其中突出显示了源代码的版本，并将一个链接添加到所有指向所描述对象源代码的对象描述中。还将插入从源到描述的链接。
警告
基本上， viewcode 扩展将导入链接到的模块。如果任何模块在导入时有副作用，这些将在 sphinx-build 运行。
如果您记录脚本（与库模块不同），请确保它们的主例程受 if __name__ == '__main__' 条件。
此外，如果不想通过以下方式导入模块： viewcode ，您可以将源代码的位置告诉 viewcode 使用 viewcode-find-source 事件。
如果 viewcode_follow_imported_members 如果已启用，则还需要使用 viewcode-follow-imported 事件。
此扩展仅适用于与HTML相关的构建器，如 html ， applehelp ， devhelp ， htmlhelp ， qthelp 等等，除了 singlehtml . 默认情况下 epub 生成器不支持此扩展（请参见 viewcode_enable_epub ）
配置¶
- viewcode_follow_imported_members¶
如果这是
True，viewcode扩展将发出viewcode-follow-imported事件以通过其他扩展解析模块的名称。默认值为True.Added in version 1.3.
在 1.8 版本发生变更: 更名为
viewcode_import到viewcode_follow_imported_members.
- viewcode_enable_epub¶
如果这是
True，即使使用epub生成器，也会启用viewcode扩展。此扩展名在目录树外生成页，但不首选此扩展名作为EPUB格式。在1.4.x之前，始终启用此扩展。如果要生成与1.4.x相同的epub，则应设置
True但EPUB格式检查的分数变差了。默认值为
False.Added in version 1.5.
警告
并非所有的ePub读卡器都支持由VIEWCODE扩展生成的页面。这些读者忽略了目录树下不存在的页面链接。
某些读卡器的呈现结果已损坏，并且 epubcheck 即使读者支持，他的分数也会变得更差。
- viewcode_line_numbers¶
默认：
False。如果设置为
True，内联行号将添加到突出显示的代码中。Added in version 7.2.
- viewcode-find-source(app, modname)¶
Added in version 1.8.
查找模块的源代码。此事件的事件处理程序应返回源代码本身的元组和标记字典。字典将类、函数、属性等的名称映射到其类型的元组、起始行号和结束行号。类型应为“class”、“def”或“other”之一。
- 参数:
app -- sphinx应用程序对象。
modname -- 要为其查找源代码的模块的名称。
- viewcode-follow-imported(app, modname, attribute)¶
Added in version 1.8.
查找属性的原始模块的名称。
- 参数:
app -- sphinx应用程序对象。
modname -- 属性所属模块的名称。
attribute -- 要跟随的成员的名称。