诗歌+狮身人面像+Cython

Question

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

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

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

我也会感谢包的链接，这些包将 poetry、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 的仪表板上激活 "Install Project" 复选框

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

诗歌+狮身人面像+Cython

Poetry + Sphinx + Cython

packaging

cython

python-sphinx

python-poetry