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

Added environment creation and doc tools install #72

Merged
merged 7 commits into from Feb 3, 2023

Conversation

melissawm
Copy link
Member

Description

This is a redo of napari/napari#4827. Also includes some reorganization on the contributing guide. cc @rwkozar

Co-authored-by: Rob Kozar rwkozar88@yahoo.com

Type of change

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment

References

Closes #46
Depends on #63 for the nice sphinx-design tabs :)

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 13, 2022
@melissawm melissawm added content Ideas for new or improved content and removed documentation Improvements or additions to documentation labels Dec 13, 2022
docs/index.md Outdated Show resolved Hide resolved
psobolewskiPhD
psobolewskiPhD previously approved these changes Dec 26, 2022
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

Made some minor changes.
There's some changes in the Installation too including the python version. That is also being changed here #51 with Chris-N-K#2
to be able to change python version in conf.py and use substitutions.

BTW I'm not sure we're officially recommending 3.10 now? CC: @jni

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 5, 2023
@melissawm
Copy link
Member Author

Thanks @psobolewskiPhD - I think I addressed most of your suggestions. The shields had been proposed by the original author - I am ok either way.

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Jan 8, 2023

@melissawm Instead of the shields, perhaps this is a good place to use the version substitution #84

This could be merged as is and then editted in that PR or the other way around. 🤷‍♂️

@psobolewskiPhD
Copy link
Member

Actually, the conda env creation could also be replaced with the substitution from #84

@melissawm
Copy link
Member Author

That's a good idea - let me do that!

@psobolewskiPhD
Copy link
Member

@melissawm So maybe we should get #84 merged before this one?

@melissawm
Copy link
Member Author

Yes - that would be helpful!

@psobolewskiPhD
Copy link
Member

Yes - that would be helpful!

Merged!

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@psobolewskiPhD psobolewskiPhD dismissed their stale review January 11, 2023 17:59

Update needed for #84

@psobolewskiPhD
Copy link
Member

I made suggestions for using the #84 substitutions.
Also I asked core-devs and for now we prefer to recommend python 3.9.
So in the conda envs, the existing (#84 merged) version is preferred.

@melissawm
Copy link
Member Author

I think I got all your comments - let me know if there's anything else. Cheers!

Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

Hi @melissawm thank you for these updates! My apologies for the delayed review as well - I've made just three small comments, but it's looking good!

docs/developers/contributing.md Outdated Show resolved Hide resolved
docs/developers/contributing.md Show resolved Hide resolved
docs/developers/contributing.md Outdated Show resolved Hide resolved
* Moving conda installation to be the first tab
* Moving contributing documentation section up
* Adding manual backend installation note
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

Looks good to me! 🎉

@melissawm melissawm mentioned this pull request Feb 2, 2023
11 tasks
@melissawm
Copy link
Member Author

@psobolewskiPhD conflicts are fixed :)

@psobolewskiPhD psobolewskiPhD merged commit 964dcce into napari:main Feb 3, 2023
@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
@melissawm melissawm deleted the update-contributing-doc branch January 9, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Ideas for new or improved content documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add environment setup steps to contributing guide
4 participants