Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: update instructions to install deps with Poetry #9743

Merged
merged 4 commits into from Nov 23, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/user/build-customization.rst
Expand Up @@ -326,15 +326,24 @@ Take a look at the following example:
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions
humitos marked this conversation as resolved.
Show resolved Hide resolved
- curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
# https://python-poetry.org/docs/#installing-with-the-official-installer
- curl -sSL https://install.python-poetry.org | python3 -
# Tell poetry to not use a virtual environment
- $HOME/.poetry/bin/poetry config virtualenvs.create false
# Install project's dependencies
- $HOME/.poetry/bin/poetry install
- $HOME/.local/bin/poetry config virtualenvs.create false
pre_install:
# Export project dependencies to requirements.txt
- $HOME/.local/bin/poetry export --with docs > docs/requirements.txt

sphinx:
configuration: docs/conf.py

python:
install:
# Install exported dependencies
- requirements: docs/requirements.txt
# Optional: install current package if imported from `docs/conf.py`
- method: pip
path: .


Override the build process
Expand Down