Sphinx将方法参数生成为项目符号,而不是表

2024-05-23 18:45:22 发布

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

我在使用karma主题通过sphinx生成api文档时遇到问题。 目前,它生成方法参数并以项目符号的形式返回,而不是以表的形式返回

左边是我们的api文档,右边是karma sphinx示例:

On the left is our api doc, on the right is the karma-sphinx example

这是我们的配置文件

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']

这是我们的模块之一

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:

是否有将项目符号更改为表格的设置,或者这是一个bug? 我们还尝试了“读取文档”主题,得到了相同的结果。 我们使用make html来构建没有错误的页面

编辑: 我尝试复制粘贴karma示例(rst+conf.py)并自己构建html,但也遇到了同样的问题。 Result when code copy pasted from the karma example 左边是我的,右边是我的例子。我也有一个朋友在他的PC上构建html,当然也在阅读文档。但是在所有版本中,这个问题仍然存在,所以sphinx/theme安装应该没有问题


Tags: path文档api主题htmlshowsphinxinheritance
1条回答
网友
1楼 · 发布于 2024-05-23 18:45:22

似乎karma sphinx(以及insegel sphinx)与当前版本的sphinx不兼容

我在Sphinx版本1.7.5中正确地工作(表而不是子弹),但是它在Sphinx 2.0上被破坏(从pip安装)

很遗憾,因为我觉得因果报应狮身人面像很漂亮

相关问题 更多 >