Sphinx:删除特定函数的包和模块名称

Sphinx: Remove package and module name for specific function(Sphinx:删除特定函数的包和模块名称)
本文介绍了Sphinx:删除特定函数的包和模块名称的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我的问题与这里的问题非常相似:Remove package and module name from sphinx function

有没有办法只为单个函数或至少为文件中的每个函数删除/隐藏Shinx中的包和模块名称(基本上是在本地更改全局conf.py设置),同时为项目的其余部分显示它们?

我一直在寻找选项,例如自动模块(:Members:,:UNDOC-Members:等),但我找不到任何隐藏此信息的指令。

推荐答案

一个选项是对cross referencing syntax使用REST标记,如下所示:

如果以~作为内容前缀,则链接文本将只是目标的最后一个组件。例如,

:py:meth:`~Queue.Queue.get`

将引用Queue.Queue.get,但仅显示get作为链接文本。

这篇关于Sphinx:删除特定函数的包和模块名称的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

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

相关文档推荐

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中安全地调用随机文件上的类型?)