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 ipython to rtd requirments file #309

Merged
merged 8 commits into from
Sep 15, 2023

Conversation

axiomcura
Copy link
Member

modified from EmbeddedArtistry

Description

Thank you for your contribution to pycytominer!
Please succinctly summarize your proposed change.
What motivated you to make this change?

Please also link to any relevant issues that your code is associated with.

What is the nature of your change?

This PR focuses on fixing the syntax highlighting not able to be rendered in the pycytominer's walkthrough webpage.

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@kenibrewer
Copy link
Member

@axiomcura I am currently working on migrating the pycytominer dependency management to poetry. I don't think this change will be something that will impact what I'm working on, but it would be really helpful if you could provide additional context about this change and why it's needed.

@axiomcura
Copy link
Member Author

Hello @kenibrewer! of course

The main issue was the pycytominer's rtd website was not rendering notebook-style walkthrough appropriately, there was no syntax highlighting.

After some digging, I found that including the ipykernel package in the requirements.txt file within the docs/ directory is necessary for the rtd website to appropriately display notebook-style tutorials.

I hope this provides more clarity. If you have any further questions or need additional assistance, please feel free to ask!

@axiomcura axiomcura requested a review from gwaybio July 11, 2023 17:33
@d33bs
Copy link
Member

d33bs commented Aug 18, 2023

Hello, this is a courtesy notice that Pcytominer's master branch has been renamed to main as part of changes merged in #303. While changes here should be seamless, GitHub is unable to change your local git environment and offers the following guidance when it comes to this. Thank you for your understanding and please don't hesitate to reach out with any questions or concerns.

image

@gwaybio gwaybio requested a review from d33bs September 1, 2023 17:29
@gwaybio
Copy link
Member

gwaybio commented Sep 1, 2023

@d33bs - can you review my recent commit when you get a chance? Our RTD build was failing https://readthedocs.org/projects/pycytominer/builds/21654686/ after the move to poetry. I tried to fix

@codecov-commenter
Copy link

Codecov Report

Merging #309 (2651fc2) into main (09b2c79) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #309   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files          56       56           
  Lines        3134     3134           
=======================================
  Hits         2990     2990           
  Misses        144      144           
Flag Coverage Δ
unittests 95.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
@gwaybio
Copy link
Member

gwaybio commented Sep 14, 2023

Thanks for the suggestions @d33bs and @kenibrewer ! It looks like the tests now pass.

Can either of you provide a 👍 and then I will merge.

Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Looks great, nice work! I tested the docs build here and everything seemed to work okay: https://readthedocs.org/projects/pycytominer-test-docs/builds/21928119/

Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

LGTM too. I'll create a separate issue for potentially migrating the rest of the docs/requirements.txt dependencies into pyproject.toml sometime in the future.

@gwaybio
Copy link
Member

gwaybio commented Sep 15, 2023

Thanks both! (and thanks to @axiomcura for initially opening this!)

Merging now

@gwaybio gwaybio merged commit 74e6c63 into cytomining:main Sep 15, 2023
10 checks passed
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.

5 participants