Skip to content

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

Merged
merged 1 commit into from
Jan 22, 2020

Conversation

Parth1811
Copy link
Contributor

@Parth1811 Parth1811 commented Jan 9, 2020

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

Copy link
Member

@stsewd stsewd left a 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

@Parth1811
Copy link
Contributor Author

@stsewd I have made the requested changes, please have a look

Copy link
Member

@stsewd stsewd left a 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.
Comment on lines +123 to +126
.. 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.
Copy link
Member

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?

Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@humitos I think your question is answered in the first line of the description of #5388

We should mention the restrictions of using conda, a better approach would be to raise an exception in the validation process, but that would break some projects, so that's not possible now.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

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 😄

@stsewd stsewd merged commit c3001be into readthedocs:master Jan 22, 2020
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.

Add note about the constrains of using conda
3 participants