flybywiresim / docs

https://docs.flybywiresim.com/
35 stars 73 forks source link

docs: Document virtualenv for docs project #989

Closed xmudrii closed 2 months ago

xmudrii commented 2 months ago

Summary

The Development Environment document for the Documentation project suggests running pip to install the needed dependencies. However, starting with Python 3.11, it's not possible to run plain pip install because it fails with the following error:

error: externally-managed-environment

with the recommendation to use virtualenv or pipx. See this StackOverflow answer for more details about this change.

To conform to this requirement, the Development Environment document has been extended to cover creating and activating virtualenv.

Location

https://docs.flybywiresim.com/dev-corner/development-projects/documentation-project/documentation/#required-tools

Discord username (if different from GitHub): xmudrii

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2024 6:54pm