如何在readthedocs上记录cython函数


问题内容

ReadTheDocs上,我不允许编译cython扩展名,是否可以进行配置sphinx以便从cython文件中提取docstring而不进行实际编译?

谢谢!


问题答案:

我遇到了同样的问题,发现现在可以在readthedocs上编译Cython扩展了。

简短的答案:Cython模块可以使用readthedocs提供的virtualenv功能进行编译。

有关稍长的答案和示例项目,请参见下文。

问题是什么?

据我所知,sphinx导入了将要记录的项目的所有模块,然后在python中提取文档字符串。对于Cython模块,此操作将失败,因为它们无法直接导入,必须先进行编译。在readthedocs上开箱即用,无法编译模块,但是它们提供了实现此目的的工具。

如何解决这个问题。

在virtualenv中安装项目时,将构建Cython模块(到.so文件中),然后可以将其导入。不过,这可能需要一些外部模块(以下示例为numpy,当然也包括Cython)。可以在存储库中的pip需求文件requirements.txt)中指定这些内容。

  1. 启用该选项install your project inside a virtualenv下的 管理 - > 高级设置 上readthedocs
  2. 输入requirements.txt相对于项目根目录的路径(docs/requirements.txt在以下示例中)
  3. (如有必要,请更改python解释器版本)

现在,python setup.py install每次构建文档时都将安装您的项目(使用)。如果您在readthedocs的 Builds
选项卡中单击相应的构建,则可以在 Setup Output 下看到安装脚本的 输出
。这是可能出现编译时错误的地方。请注意,编译项目可能需要一些时间。 __

示例项目

一个Python软件包,由多个Cython模块组成,每个模块都有Google样式的docstrings

my_project/
    setup.py
    my_package/
        __init__.py   # imports Cython modules
        cython_module1.pyx
        cython_module2.pyx
        ...
    docs/
        requirements.txt
        Makefile
        source/
            conf.py
            index.rst
            ... #  more documentation

requirements.txt

cython>=0.20
numpy>=1.9

注意事项

在我的项目上尝试时,我遇到了无法导入Cython模块的问题。Sphinx的错误消息显示为:

home/docs/checkouts/readthedocs.org/user_builds/... :4: WARNING: autodoc: failed to import module 'cython_module1';...
File "/home/docs/checkouts/readthedocs.org/user_builds/.../__init__.py", ...
from .cython_module1 import CythonClass

发生这种情况是因为我曾经在本地构建我的文档,并添加了一行

...
sys.path.insert(0, os.path.abspath('../../')) # path to my_package
...

对我的conf.py建议在这里。这已经解决了我在本地构建时的问题(使用在那里我编译了项目python setup.py build_ext --inplace),但是在virtualenv中安装时,这指向了错误的my_package版本(即源代码,而不是已安装的软件包)。那里的狮身人面像找不到任何要导入的.so文件。

要解决此问题,只需完全删除该行。

我希望这有帮助。