Как собрать документацию по Cython на readthedoc и в локальной

Question

Я сейчас работаю над проектом Cython.

После некоторых уроков я смог build in place cython, а затем использовать сборку sphinx со строкой

sys.path.insert(0, os.path.abspath('../../')) # path to my_package в моем conf.py, чтобы он заработал.

К сожалению, мне нужно удалить эту строку, чтобы она работала с readthedocs, как предложено здесь: как документировать функцию cython в 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 и следуйте остальным инструкциям по ссылке, указанной в вашем вопросе.