cython - 诗歌+狮身人面像+Cython

Question

我使用诗歌构建我的 cython 包。我在所有函数和类中都有 NumPy 风格的文档字符串。我现在要做的是添加 Sphinx 自动文档并发布在 Read the Docs。

我已阅读此主题 How do I use Sphinx with Cython?并了解首先我必须编译我的 .pyx 文件。但是，当我最后调用 poetry build 时，我只得到 .tar.gz 和 .whl 文件，没有 .pyd 或 .so 文件。

所以问题如下:是否有任何方法可以在诗歌构建过程中插入回调，以便在调用某些参数时自动生成文档？

我也会欣赏到包的链接，它们一起使用诗歌、sphinx 和 cython，以便我可以从中学习。

Answer 1

我写了一个带例子的小教程。您可以在这里找到它:https://github.com/iamishalkin/cyrtd

要点:

添加readthedocs.yml

version: 2

python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs
    - method: pip

sphinx:
  configuration: docs/source/conf.py

在pyproject.toml中添加依赖:

[tool.poetry.dependencies]
python = "^3.7"
cython = "^0.29.13"

sphinx = { version = "^2.2", optional = true }
sphinx_rtd_theme = { version = "^0.4.3", optional = true  }

[tool.poetry.extras]
docs = ["sphinx", "sphinx_rtd_theme"]

在 ReadTheDocs 的仪表板上激活“安装项目”复选框

setup.py 有一种不优雅的解决方法。如果您知道如何解决这个问题，请告诉我。