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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New readme section : Requirements to build html page in virtual environments #443

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

antoinemeyer5
Copy link
Collaborator

Simple guide for indicate:

  • how to set up from scratch a Python virtual environment locally on a machine,
  • install in that virtual environment all the requirements for the wiki build and
  • do the build in that "safe" environment

The aim is to help documentation creators to:

  • be in a controlled environment where they can be sure of using the right tools, versions, etc,
  • detect potential errors or warnings as early as possible

@antoinemeyer5 antoinemeyer5 requested a review from fnrizzi July 21, 2023 09:38
Copy link
Contributor

@ajpowelsnl ajpowelsnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong opinion about this PR, other than the security caveat about using the PyCharm IDE in certain work environments. In any case, the merits of this approach vs. base install of the requirements, iterating change quickly by simply opening newly built file in a browser, are unclear. Perhaps it makes more sense if one is using an IDE ...?

@@ -1,5 +1,5 @@
# Python Virtual Environment
/venv
/env
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CAVEAT: there might be limits on using this (PyCharm) IDE in certain environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants