我正在构建一个使用keras类的软件包。
我正在使用Sphinx生成我的文档,并使用带有拿破仑的Google文档字符串约定来解析它。
我的某些方法覆盖了keras方法,但未记录,因此Sphinx autodoc继承了keras中原始重写方法的文档字符串。
不幸的是,keras中的文档没有遵循Google,numpy或reST docstring约定。我认为这是一种Google约定,带有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文档字符串的所有文档看起来都被无法识别的'#'符号破坏了。
正确解析此keras docstring约定的方法是什么?