Skip to content

Commit

Permalink
Docs: fix example for installing deps with Poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
browniebroke committed Nov 20, 2022
1 parent abaa5c0 commit d2fdbc2
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/user/build-customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -330,11 +330,20 @@ Take a look at the following example:
- curl -sSL https://install.python-poetry.org | python3 -
# Tell poetry to not use a virtual environment
- $HOME/.local/bin/poetry config virtualenvs.create false
# Install project's dependencies
- $HOME/.local/bin/poetry install
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

0 comments on commit d2fdbc2

Please sign in to comment.