链接到Shinx中的源代码文件

linking to source code file in sphinx(链接到Shinx中的源代码文件)
本文介绍了链接到Shinx中的源代码文件的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我正在用Sphinx记录一个Python模块。我有一个源代码文件,里面充满了使用我的模块的示例。我想参考一下这份文件。它太长,无法内联为连续代码。有没有办法创建到完整源文件的链接,以代码友好的方式(如文字或行号)格式化?

谢谢。

推荐答案

Python3可以做到这一点。例如,the argparse docs链接到源代码(靠近页面顶部,其中显示"源代码")。您可以通过查看source for the docs(从第一个链接链接到左下方HAD列的下方)来了解他们是如何做到这一点的。

我假设他们使用的是标准Sphinx,但我很难在他们的文档中找到:source:...

更新:source:角色已定义here。

这篇关于链接到Shinx中的源代码文件的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)