Sphinx 将方法参数生成为要点而不是 table
Sphinx generates method arguments as bullet points instead of as a table
我在使用 karma 主题通过 sphinx 生成 api 文档时遇到问题。
目前,它生成方法参数和 returns 作为要点而不是 table.
左边是我们的 api 文档,右边是 karma-sphinx 示例:
这是我们的conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('./..'))
project = 'x'
copyright = 'x'
author = 'x'
release = 'alpha'
extensions = ['sphinx.ext.autodoc',
'm2r2',
'sphinx.ext.napoleon'
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'karma_sphinx_theme'
html_static_path = []
autodoc_mock_imports = ['sip', 'PyQt5', 'PyQt5.QtGui', 'PyQt5.QtCore', 'PyQt5.QtWidgets', 'digi',
'flask', 'baseconvert', 'numpy', 'dronekit', 'pyzmq', 'matplotlib', 'requests', 'future', 'flask_cors']
这是我们的模块之一.rst
Frontend package
================
Subpackages
-----------
.. toctree::
:maxdepth: 4
Frontend.Components
Frontend.Map
Frontend.MainWindow module
--------------------------
.. automodule:: Frontend.MainWindow
:members:
:undoc-members:
:show-inheritance:
Frontend.MainWindowUI module
----------------------------
.. automodule:: Frontend.MainWindowUI
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: Frontend
:members:
:undoc-members:
:show-inheritance:
是否有设置可以将它从项目符号更改为 table 或者这是一个错误?
我们还尝试了阅读文档主题,结果相同。
我们使用 make html
来构建没有错误的页面。
编辑:
我试图复制粘贴业力示例 (rst + conf.py 并自己构建 html 并遇到了同样的问题。
再一次左边是我的,右边是例子。我还有一个朋友在他的 PC 上构建了 html,当然还有 read-the-docs。但是在所有版本中问题都存在,所以应该不是 sphinx / theme install 的问题。
karma-sphinx(以及与此相关的 insegel-sphinx)似乎不能很好地与当前版本的 Sphinx 配合使用。
我在 Sphinx 版本 1.7.5 中正常工作(table 而不是项目符号),但它从 Sphinx 2.0 开始就坏了(从 pip 安装)。
真可惜,因为我觉得karma-sphinx很漂亮。
我在使用 karma 主题通过 sphinx 生成 api 文档时遇到问题。 目前,它生成方法参数和 returns 作为要点而不是 table.
左边是我们的 api 文档,右边是 karma-sphinx 示例:
这是我们的conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('./..'))
project = 'x'
copyright = 'x'
author = 'x'
release = 'alpha'
extensions = ['sphinx.ext.autodoc',
'm2r2',
'sphinx.ext.napoleon'
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'karma_sphinx_theme'
html_static_path = []
autodoc_mock_imports = ['sip', 'PyQt5', 'PyQt5.QtGui', 'PyQt5.QtCore', 'PyQt5.QtWidgets', 'digi',
'flask', 'baseconvert', 'numpy', 'dronekit', 'pyzmq', 'matplotlib', 'requests', 'future', 'flask_cors']
这是我们的模块之一.rst
Frontend package
================
Subpackages
-----------
.. toctree::
:maxdepth: 4
Frontend.Components
Frontend.Map
Frontend.MainWindow module
--------------------------
.. automodule:: Frontend.MainWindow
:members:
:undoc-members:
:show-inheritance:
Frontend.MainWindowUI module
----------------------------
.. automodule:: Frontend.MainWindowUI
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: Frontend
:members:
:undoc-members:
:show-inheritance:
是否有设置可以将它从项目符号更改为 table 或者这是一个错误?
我们还尝试了阅读文档主题,结果相同。
我们使用 make html
来构建没有错误的页面。
编辑:
我试图复制粘贴业力示例 (rst + conf.py 并自己构建 html 并遇到了同样的问题。
karma-sphinx(以及与此相关的 insegel-sphinx)似乎不能很好地与当前版本的 Sphinx 配合使用。
我在 Sphinx 版本 1.7.5 中正常工作(table 而不是项目符号),但它从 Sphinx 2.0 开始就坏了(从 pip 安装)。
真可惜,因为我觉得karma-sphinx很漂亮。