Sphinx "epytext" 扩展
项目描述
Sphinx epytext 支持
======================
sphinx-epytext 为 epytext 文档字符串提供基本支持
<http://epydoc.sourceforge.net/epytext.html>
在 Sphinx 自动文档 <https://sphinx-doc.cn/ext/autodoc.html> 中。
它连接到 Sphinx 的 'autodoc-process-docstring' 钩子，以执行以下操作
- 将 '@' 替换为 ':' 用于 epydoc 字段。<http://epydoc.sourceforge.net/fields.html>
- 将 L{..} 和 C{..} 替换为 :py:obj:`..`
- 从链接周围删除 U{..}
配置
-------------
在您的 ``conf.py`` 中将其添加到扩展中：
extensions = [
'sphinx.ext.autodoc',
'sphinx_epytext',
# 您的其他 Sphinx 扩展
# ...
]
然后，运行 ``sphinx-build``。
======================
sphinx-epytext 为 epytext 文档字符串提供基本支持
<http://epydoc.sourceforge.net/epytext.html>
在 Sphinx 自动文档 <https://sphinx-doc.cn/ext/autodoc.html> 中。
它连接到 Sphinx 的 'autodoc-process-docstring' 钩子，以执行以下操作
- 将 '@' 替换为 ':' 用于 epydoc 字段。<http://epydoc.sourceforge.net/fields.html>
- 将 L{..} 和 C{..} 替换为 :py:obj:`..`
- 从链接周围删除 U{..}
配置
-------------
在您的 ``conf.py`` 中将其添加到扩展中：
extensions = [
'sphinx.ext.autodoc',
'sphinx_epytext',
# 您的其他 Sphinx 扩展
# ...
]
然后，运行 ``sphinx-build``。
