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

Use reference labels instead of paths #301

Merged
merged 3 commits into from
Jan 23, 2024

Conversation

lucyleeow
Copy link
Collaborator

@lucyleeow lucyleeow commented Dec 7, 2023

References and relevant issues

towards #296

Description

Uses references labels instead of paths. A few notes:

  • I have left all the paths inside docs/plugins/virtual_environment_docs as they just reference files within that folder so I think we're safe
  • I did not know how to deal with gallery/ links. Does sphinx-tag automatically generate the gallery index/readme page..?
  • Standardised use of - between words in reference labels
  • Removed napari from some reference labels, as there is no 'plugin' equivalent thus its obvs it is about napari
  • Images! - We still have a lot of relative paths to image/animation files. These would ideally be absolute paths, meaning they would be fine as long as the images stay in the same folder, but I could not be bothered. Maybe will leave this to be fixed when needed....

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 7, 2023
@psobolewskiPhD psobolewskiPhD self-requested a review December 7, 2023 01:47
@lucyleeow
Copy link
Collaborator Author

Sorry it's not going to be fun to review. I also sort of regret taking this on 😬

@psobolewskiPhD
Copy link
Member

Yea 😅
I think the first goal should be making sure every page has a tag/anchor that can be used for cross referencing.
Then second pass is to replace any path based links?

@lucyleeow
Copy link
Collaborator Author

Do you think thats going to be much easier to review than this PR?

@psobolewskiPhD
Copy link
Member

I have no idea 😆
Don't worry about it, you're doing the hard work!

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.

I went through everything and it's great!
Just a couple small nits...

...plus merge conflicts 😬

@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Jan 20, 2024
@lucyleeow
Copy link
Collaborator Author

...plus merge conflicts 😬

Oooff I just realised, let me have a look. I am worried the merge conflicts are too complex after my extending napari PR re-organise. I'm tempted to abandon this PR, WDYT?

@lucyleeow
Copy link
Collaborator Author

lucyleeow commented Jan 22, 2024

Okay the conflicts were not as bad as I imagined. I was worried because I had moved files around in other PRs that have now been merged.

@psobolewskiPhD thanks for the review, changes made! (if possible would be great to get this in to avoid more merge conflicts!)

@psobolewskiPhD
Copy link
Member

Thanks for your efforts @lucyleeow
I've marked ready for merge and will merge tomorrow--if I don't, please ping me!

@lucyleeow
Copy link
Collaborator Author

@psobolewskiPhD ping, can this go in? Thank you 🙏

@psobolewskiPhD psobolewskiPhD merged commit e9e874f into napari:main Jan 23, 2024
6 checks passed
@psobolewskiPhD
Copy link
Member

Done--sorry & thanks.

@lucyleeow lucyleeow deleted the ref_label branch January 23, 2024 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants