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

Add note about the constrains of using conda #5388

Closed
stsewd opened this issue Mar 3, 2019 · 11 comments · Fixed by #6509
Closed

Add note about the constrains of using conda #5388

stsewd opened this issue Mar 3, 2019 · 11 comments · Fixed by #6509
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required

Comments

@stsewd
Copy link
Member

stsewd commented Mar 3, 2019

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.

Constraints:

  • The virtual environment creation in managed by conda
  • So, syste_packages does't have any effect
  • The python version doesn't have any effect, that's managed by conda
  • We don't install requirements from files here (but we could do it Support pip install inside conda environment #2776)

Docs that should be changed https://docs.readthedocs.io/en/stable/config-file/v2.html#conda

Maybe the docs from v1 too? and the page about conda support?

Ref #5387 (comment)

@stsewd stsewd added Good First Issue Good for new contributors Needed: documentation Documentation is required labels Mar 3, 2019
@Mike-Dai
Copy link
Contributor

Mike-Dai commented Mar 3, 2019

Can I work on this issue?

@humitos
Copy link
Member

humitos commented Mar 3, 2019

@Mike-Dai hi! I think the actions for this issue are not well defined yet. Although, if you want, you can start with a proposal of how to do it and what to change and where (considering the context that Santos wrote in the description)

@Mike-Dai
Copy link
Contributor

Mike-Dai commented Mar 4, 2019

@stsewd @humitos
Here is my proposal:
1.In docs/config-file/v2.rst, add a warning below python.system_packages, which says "If you install your project with conda, you should not set the value to True. Because the virtual environment creation in managed by conda. So, syste_packages does't have any effect."
2.In the same file, add a note below python.verison part, which says: "If you use conda, the python version doesn't have any effect, that's managed by conda."
3.In the same file, Add a note below Requirements file part, which says: "If you use a conda environment, we don't install requirements from files here. You have to put the pip requirements inside the environment.yml used by conda."
4.If we need to modify the Conda support page, I will add a warning in docs/conda.rst that includes all constraints.
5.If we need to modify the V1 docs, I will made respective change similar to V2 docs.
6.According to the advice given in issues #5387, maybe we can add a link in conda part to tell users use pip when possible. Also, we can add a warning to remind users that RTD can't handle building too big conda environments.

@Mike-Dai
Copy link
Contributor

Mike-Dai commented Mar 4, 2019

Should I open a PR or wait for more discussion? Please let me know if any changes required.

@stale
Copy link

stale bot commented Apr 18, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Apr 18, 2019
@stsewd stsewd removed the Status: stale Issue will be considered inactive soon label Apr 18, 2019
@stale
Copy link

stale bot commented Jun 2, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jun 2, 2019
@dojutsu-user dojutsu-user removed the Status: stale Issue will be considered inactive soon label Jun 2, 2019
@stsewd stsewd added the Accepted Accepted issue on our roadmap label Jun 2, 2019
@humitos
Copy link
Member

humitos commented Jun 4, 2019

@stsewd what do you think about @Mike-Dai proposal?

@stsewd
Copy link
Member Author

stsewd commented Jun 4, 2019

@humitos, @Mike-Dai looks great, we should add the same notes under the conda setting too.

@namanbansal013
Copy link

@stsewd I'd like to work on this issue. Should I add the constraints to docs of v1 too? Also, I'm not able to locate conda support page. Can you please guide me through it.

@stsewd
Copy link
Member Author

stsewd commented Nov 27, 2019

@namanbansal013 starting with updating the v2 docs should be a good first step, we can see if it
s needed to update other places after that.

@Parth1811
Copy link
Contributor

I'm starting work on this issue as I see no new updates recently. @namanbansal013 if you have made any progress, please do share with me.

Parth1811 added a commit to Parth1811/readthedocs.org that referenced this issue Jan 9, 2020
…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.
Parth1811 added a commit to Parth1811/readthedocs.org that referenced this issue Jan 9, 2020
…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.
Parth1811 added a commit to Parth1811/readthedocs.org that referenced this issue Jan 9, 2020
…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.
Parth1811 added a commit to Parth1811/readthedocs.org that referenced this issue Jan 9, 2020
…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.
Parth1811 added a commit to Parth1811/readthedocs.org that referenced this issue Jan 15, 2020
…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.
stsewd added a commit that referenced this issue Jan 22, 2020
Fixes #5388 -- Added Documentation for constraint while using Conda
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants