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

Update ImageJ2/Fiji version in the docs and improve toc layout #276

Merged
merged 13 commits into from
Aug 10, 2023

Conversation

elevans
Copy link
Member

@elevans elevans commented Jul 7, 2023

This PR is in response to #271 and updates the version of ImageJ2/Fiji we use from 2.5.0 to 2.13.1. I also applied the following changes:

  • Reorganized the table of contents into sections (taking a hint from how read the docs setup their toc).
  • Replaced the blood vessel image in notebook 03-Sending-Data-to-Java with a slice of microtubules from a HeLa cell in metaphase that I took a few years back.
  • Removed references to the dummy image HACK.

@elevans elevans force-pushed the update-docs-layout-and-content branch from afcdccd to 7c99ee1 Compare July 11, 2023 14:01
@elevans elevans requested review from hinerm and gselzer July 11, 2023 14:42
Copy link
Contributor

@gselzer gselzer left a comment

Choose a reason for hiding this comment

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

@elevans I like all of the changes - in fact, most of my comments probably aren't related to your changes.

One final question - can you build the documentation? I ran make docs && firefox doc/_build/html/index.html, but it errors.

doc/03-Sending-Data-to-Java.ipynb Show resolved Hide resolved
doc/06-Working-with-Images.ipynb Outdated Show resolved Hide resolved
doc/06-Working-with-Images.ipynb Outdated Show resolved Hide resolved
doc/07-Running-Macros-Scripts-and-Plugins.ipynb Outdated Show resolved Hide resolved
doc/07-Running-Macros-Scripts-and-Plugins.ipynb Outdated Show resolved Hide resolved
doc/08-Discover-and-run-ImageJ-commands.ipynb Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jul 31, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (d99fcf0) 77.60% compared to head (c5214a0) 77.60%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #276   +/-   ##
=======================================
  Coverage   77.60%   77.60%           
=======================================
  Files          16       16           
  Lines        1947     1947           
=======================================
  Hits         1511     1511           
  Misses        436      436           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@elevans elevans force-pushed the update-docs-layout-and-content branch 2 times, most recently from 83b3795 to 746af2e Compare August 2, 2023 20:36
@hinerm
Copy link
Member

hinerm commented Aug 3, 2023

@elevans @gselzer what do you think about changing the verbosity in the affected notebooks to avoid these printouts? Is that a possibility?

@elevans
Copy link
Member Author

elevans commented Aug 3, 2023

I think this might be confusing for people and might generate erroneous bug reports. If someone sees our notebooks with the clean output but theirs is duplicating they might reach out to us.

Sphinx doesn't like "!pip" with a python language
code block.
The blood vessel image is no longer available. This commit
swaps the blood vessel image with a slice from a 4D dataset that
contains microtubules in metaphase.
Re-run all jupyter notebooks and save their output with
ImageJ2 version 2.13.1.
This commit reorganizes the table of contents
for the read the docs site. I added sections and emojis to
enhance readability and create a more welcoming experince for
visitors.
NumPy arrays go to `net.imagej.DefaultDataset` and don't
make an `ImgView`.
I accidentally ran the notebook without itkwidgets
and pushed the output.
The output was only displaying the first cell.
I also fixed the column names. Pandas thought
it was a multi-level column name.
We fixed a duplicating stdout and stderr in commit
d99fcf0 thus we need to recreate the notebook outputs.
@elevans elevans force-pushed the update-docs-layout-and-content branch from 411250b to c5214a0 Compare August 8, 2023 17:42
@elevans
Copy link
Member Author

elevans commented Aug 8, 2023

@elevans I like all of the changes - in fact, most of my comments probably aren't related to your changes.

One final question - can you build the documentation? I ran make docs && firefox doc/_build/html/index.html, but it errors.

I wasn't able to reproduce this. This command works fine on my end. I did make setup first which created the pyimagej-dev environment and then the make docs command without any issues.

@elevans elevans merged commit 4350c89 into main Aug 10, 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.

4 participants