如何为micropython构建sphinx文档

2024-05-28 20:10:05 发布

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

如何配置sphinx来记录用于MicroPython解释器的模块?你知道吗

我面临的基本问题是sphinx从导入的模块获取它所记录的信息。因此,用于记录模块的python解释器必须可导入到解释器中。你知道吗

第一个问题

我用的是pyboard,很自然

import pyb

找不到模块pyb。。。 所以我加入了conf.py

from unittest.mock import MagicMock
sys.modules['pyb'] = MagicMock()  # and many more

第二个问题

我的一个MicroPython库叫做cmd

Exception occurred:
  File "/usr/lib/python3.5/pdb.py", line 135, in <module>
    class Pdb(bdb.Bdb, cmd.Cmd):
AttributeError: module 'cmd' has no attribute 'Cmd'

所以说得通。。。我将模块的名称改为ucmd,这似乎起作用了。。。但这很危险。你知道吗

问题

有没有合适的方法? sphinx记录一个没有为运行sphinx-build命令的平台设计的模块?你知道吗

措辞更实际:如果我想记录一个名为collectionssubprocessio(所有这些都由sphinx库使用)的MicroPython模块,是否可以使用sphinx来实现这一点?你知道吗

或者我只是满足于分别命名它们ucollectionsusubprocessuio?你知道吗


Tags: 模块pyimportcmd信息confsphinx记录

热门问题