我用诗歌来制作我的cython软件包。我在所有函数和类中都有NumPy样式的文档字符串。我现在要做的是添加Sphinx自动文档,并在“阅读文档”中发布。
我已经阅读了该线程How do I use Sphinx with Cython?,并且了解到我首先必须编译.pyx文件。但是,当我最后致电poetry build
时,只会得到.tar.gz和.whl文件,而没有.pyd或.so文件。
接下来的问题是:有什么方法可以在诗歌构建过程中插入回调,以便在调用带有某些参数的文档时自动生成文档?
我还将欣赏与诗歌,狮身人面像和cython一起使用的软件包链接,以便我可以从中学习。
答案 0 :(得分:0)
我用示例编写了一个小教程。您可以在这里找到它: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
有一种解决方法。如果您知道如何解决此问题,请告诉我。