当用autod继承keras docstring时,如何用Sphinx解析它们

2024-10-02 04:29:33 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在构建一个使用keras类的包。
我正在用Sphinx生成文档,使用googledocstring约定和napoleon来解析它。你知道吗

我的一些方法覆盖了keras方法,并且没有文档记录,因此Sphinx autodoc继承了keras中原始覆盖方法的docstring。你知道吗

不幸的是,keras中的文档没有遵循Google、numpy和reST docstring约定。这是一种谷歌的惯例,上面有来自markdown的“#”符号,我想,这里有一个例子:

def keras_doc_example(inputs, **kwargs):
  """
  # Arguments
        inputs: Can be a tensor or list/tuple of tensors.
        **kwargs: Additional keyword arguments.

  # Returns
        An output.
  """

因此,当我构建文档时,keras docstring中的所有文档看起来都被未识别的“#”符号破坏了。你知道吗

正确解析keras docstring约定的方法是什么?你知道吗


Tags: 方法文档numpyrestsphinxgoogle记录符号

热门问题