如何为Micropython构建Sphinx文档

时间:2019-04-17 12:42:27

标签: python python-sphinx micropython

如何配置sphinx来记录打算用于MicroPython解释器的模块?

我面临的基本问题是狮身人面像从导入的模块获取它记录的信息。因此,用于记录模块的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,这似乎可以正常工作...但这是suuuuuper狡猾的。

问题

是否有适当的方法来做到这一点? 要为狮身人面像文档记录运行平台sphinx-build的平台的未设计模块?

更实用的短语:如果我想记录一个名为collectionssubprocessio(它们全部由sphinx库使用)的MicroPython模块,可以使用狮身人面像这样做吗?

还是只需要对它们分别命名为ucollectionsusubprocessuio就满意了?

0 个答案:

没有答案