我正在尝试使用狮身人面像autodoc http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html扩展,特别是automodule
指令自动为我正在开发的 django 应用程序生成文档。问题是我想创建对模块内不同类的内部引用,而不必使用autoclass
and autofunction
项目中的每个类/函数。对于这样的源文件:
# source_code.py
class A:
"""docs for A
"""
pass
class B:
"""docs for B with
:ref:`internal reference to A <XXXX-some-reference-to-A-XXXX>`
"""
pass
我希望能够有一个像这样的 sphinx 文档文件:
.. automodule: source_code
我可以使用什么参考来 XXXX-some-reference-to-A-XXXX?有没有一种简单的方法可以实现这一点?在此先感谢您的帮助。
您可以引用这样的类:
class B(object):
"""docs for B with reference to :class:`.A`"""
pass
Sphinx 会智能地尝试找出您所引用的内容。如果有多个同名类A
,您可能会收到警告,但它应该选择当前模块中的警告。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)