如何在 readthedoc 和本地构建 cython 文档
How to build the cython doc on readthedoc and in local
我目前正在做一个 cython 项目。
在学习了一些教程之后，我能够 build in place cython，然后使用 sphinx build 和
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.
我想避免在本地做同样的事情，因为这很耗时。有别的办法吗？哪一种是最佳做法？
始终创建和使用虚拟环境。 venv 是 Python 3 中的一个创建虚拟环境的工具，所以没有 "create a 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 操作，并按照您在问题中提供的 link 中的其余说明进行操作。
我目前正在做一个 cython 项目。
在学习了一些教程之后，我能够 build in place cython，然后使用 sphinx build 和
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.
我想避免在本地做同样的事情，因为这很耗时。有别的办法吗？哪一种是最佳做法？
始终创建和使用虚拟环境。 venv 是 Python 3 中的一个创建虚拟环境的工具，所以没有 "create a 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 操作，并按照您在问题中提供的 link 中的其余说明进行操作。