Furo Sphinx主题在API文档中大写过多
我面临着这个问题中讨论的相同问题：Furo Sphinx theme uppercases too much in API documentation。但是，接受的解决方案不起作用，似乎Furo模板以某种方式覆盖了custom.css： 感谢在Furo Sphinx theme中实现此简单自定义的任何帮助。 推荐答案 注意：该问题已在Furo 2022.1.2中修复。 好的，尽
..
numpydoc相关内容
是否可以在Sphinx中隐藏Python函数参数？
假设我有以下Numpydoc style中记录的函数，文档是通过Sphinxautofunction directive自动生成的： def foo(x, y, _hidden_argument=None): """ Foo a bar. Parameters ---------- x: str The first argument
..
警告：toctree包含对Sphinx不存在的文档错误的引用
几天前我开始使用Sphinx来记录一个Python包，我得到了一个似乎很常见的错误，但我找不到解决方案。 我使用了狮身人面像-快速入门来设置一切。我使用“doc/”作为文档的根位置。包含我的包的文件夹设置为： myfolder/ doc/ mypackage/ __init__.py moprob.py ... 快速入
..
mypy 可以检查文档字符串吗?
我有 numpydoc 样式的文档字符串: def foobar(filename, copy, dtype, iterable, shape, files):"""foobar 是 42.参数----------文件名:str复制:布尔dtype : 数据类型可迭代:可迭代对象形状 : int 或 int 元组文件:str列表退货-------foobarfoo : 整数"""经过
..
有什么方法可以减少Python文件的数量，以检查Numpy文档样式是否符合要求？
我正在一个需要Numpy文档的项目中。在我使用Java的日子里，我记得曾在Linux / IDEA中检查过Javadoc遵从性的短毛猫。 我知道PEP257，但似乎没有针对Numpy文档的任何特定检查。 > 解决方案 Pylint似乎支持这一点。看看 pylint.extensions.docparams 。 总结一下。您可以通过添加 load-plugins = py
..
Sphinx不删除html输出中的doctest标志
我无法消除doctest标志（即 ，＃doctest：+ ELLIPSIS ） html输出。我能够生成所需的文档，因此没有错误，但其中包含我要删除的这些标记。 Sphinx文档此处声称这样做是可能的，我一定做错了什么。我的文档示例为numpy样式，并且我尝试同时使用napoleon和numpydoc扩展名。 以下是我已采取的步骤。 运行 sphinx-quic
..
如何解析numpydoc文档字符串并访问组件?
我想解析一个numpydoc文档字符串，并以编程方式访问每个组件. 例如: def foobar(a, b): '''Something something Parameters ---------- a : int, default: 5 Does something cool b : str Wow ''' 我想做
..