3

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

我已阅读此线程如何将 Sphinx 与 Cython 一起使用？并了解首先我必须编译我的 .pyx 文件。但是，当我poetry build最后打电话时，我只得到 .tar.gz 和 .whl 文件，没有 .pyd 或 .so 文件。

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

我还将欣赏包的链接，将诗歌、狮身人面像和 cython 一起使用，以便我可以从中学习。

4

1 回答 1

2

我写了一个带有示例的小教程。你可以在这里找到它：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。如果你知道如何克服这个问题，请告诉我。

于 2019-09-30T07:38:30.363 回答