Skip to content

Fixes #5388 -- Added Documentation for constraint while using Conda - #6509

Merged
stsewd merged 1 commit into
readthedocs:masterfrom
Parth1811:issue_5388
Jan 22, 2020
Merged

stsewd merged 1 commit into
readthedocs:masterfrom
Parth1811:issue_5388

Conversation

@Parth1811

@Parth1811 Parth1811 commented Jan 9, 2020 •

Copy link
Copy Markdown
Contributor

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

@stsewd stsewd left a comment

Copy link
Copy Markdown
Member

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

Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
@Parth1811

Copy link
Copy Markdown
Contributor Author

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

Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved
Comment thread docs/config-file/v2.rst Resolved

@stsewd stsewd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

Comment thread docs/config-file/v2.rst Resolved
…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 thread docs/config-file/v2.rst
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
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