-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Fixes #5388 -- Added Documentation for constraint while using Conda #6509
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, just leave some suggestions to make the docs more brief and consistent
@stsewd I have made the requested changes, please have a look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
…ing Conda This patch adds few notes and warnings in the configuration file documentation, which will warn the user if he/she is using conda enviroment to setup the docs.
.. warning:: | ||
|
||
If you are using a :ref:`Conda <config-file/v2:conda>` environment to manage | ||
the build, this setting will not have any effect, as the Python version is managed by Conda. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stsewd what about making these notes as validation errors when the build is triggered? I feel that it only adds confusion to users the ability to use both at the same time and do not receive any error when building?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, we can raise an error in addition to just put it in the docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Parth1811 thanks for pointing that, didn't remember I wrote that 😄
This patch adds few notes and warnings in the configuration file documentation,
which will warn the user if he/she is using conda enviroment to setup the docs.
Fixes #5388