Python 如何在Sphinx autodoc中创建函数签名之间的水平线和空白
我已经找到了sphinx选项来完成我想做的大部分工作,但是我看不出在使用autodoc时如何在函数签名之间插入空格和水平线 以下是autodoc的产品:Python 如何在Sphinx autodoc中创建函数签名之间的水平线和空白,python,formatting,python-sphinx,read-the-docs,autodoc,Python,Formatting,Python Sphinx,Read The Docs,Autodoc,我已经找到了sphinx选项来完成我想做的大部分工作,但是我看不出在使用autodoc时如何在函数签名之间插入空格和水平线 以下是autodoc的产品: get_all_edges(network=None, base_url='http://localhost:1234/v1') docstring for get_all_edges get_all_nodes(network=None, base_url='http://localhost:1234/v1') docstrin
get_all_edges(network=None, base_url='http://localhost:1234/v1')
docstring for get_all_edges
get_all_nodes(network=None, base_url='http://localhost:1234/v1')
docstring for get_all_nodes
get_edge_count(network=None, base_url='http://localhost:1234/v1')
docstring for get_edge_count
以下是我想要得到的:
get_all_edges(network=None, base_url='http://localhost:1234/v1')
docstring for get_all_edges
------------------------------------------------------------
get_all_nodes(network=None, base_url='http://localhost:1234/v1')
docstring for get_all_nodes
------------------------------------------------------------
get_edge_count(network=None, base_url='http://localhost:1234/v1')
docstring for get_edge_count
。。。或者类似的东西。我对最后一个函数签名是否有尾随分隔符并不感兴趣。也许这很简单,但我看不出来。谢谢
仅供参考,以下是生成我的函数签名的autodoc指令:
PyCy3.networks module
---------------------
.. automodule:: PyCy3.networks
:members:
:undoc-members:
:show-inheritance:
事实证明,这并不难。。。在做了一天的研究之后。:) 主要见解是:
我使用的是Sphinx 3.2,并且我能够添加自定义CSS来完成以下工作:Sphinx是一个文档系统,它尽可能好地将文本和格式分开(正如它应该的那样)。一般来说,按内容添加格式不是一个好主意。如果要更改格式,请调整模板和/或样式表。使用
autofunction
而不是automodule
,可以实现所需的功能。类似于这里的另一个优秀的如何做的事情,像这样的魅力,谢谢!在我的例子中,文件夹\u templates
和\u static
已经存在,但是在docs
文件夹中的source
文件夹中。我将css
子文件夹添加到\u static
中,以及您向他们建议的文件,一切都很顺利。
{% extends "!layout.html" %}
{% set css_files = css_files + [ "_static/css/functions.css" ] %}
.function {
border-bottom: 3px solid #d0d0d0;
padding-bottom: 10px;
padding-top: 10px;
}