如何在readthedoc和本地构建cython doc

Question

我目前正在开展一个cython项目。

在完成一些教程后，我能够使用build in place cython，然后使用sphinx build with the line

sys.path.insert(0, os.path.abspath('../../')) # path to my_package在我的conf.py中使它工作。

不幸的是，我需要删除此行以使其与readthedocs一起使用，如下所示：how to document cython function on readthedocs。

我的问题是，在阅读文档和本地使用相同代码构建文档的最佳做法是什么？

read-the-docs创建一个venv，pip安装要求，安装cython项目，然后运行sphinx-build。

我想避免在本地做同样的事情，因为这很费时间。是否有其他方式？哪一个是最佳做法？

Answer 1

始终创建和使用虚拟环境。 venv是Python 3中创建虚拟环境的工具，因此不会“创建一个venv”。将软件包和项目安装到虚拟环境中。

# create and change working directory
mkdir ~/projects/myproject
cd ~/projects/myproject
# create a virtual environment for your project
python3 -m venv env
# activate the virtual environment
source env/bin/activate
# optionally upgrade packaging tools
pip install --upgrade pip setuptools
# install your package in editable mode into your virtual environment
pip install -e .
# install other packages into your virtual environment
pip install sphinx another_package one_more_package

现在做你所有的Sphinx内容，并按照你在问题中提供的链接中的其余说明进行操作。