8000 Updates to the makefile, contribution guide, and README for the napari[docs] installation by psobolewskiPhD · Pull Request #602 · napari/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Updates to the makefile, contribution guide, and README for the napari[docs] installation #602

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 18 commits into from
Mar 11, 2025
Merged

Updates to the makefile, contribution guide, and README for the napari[docs] installation #602

merged 18 commits into from
Mar 11, 2025

Conversation

psobolewskiPhD
Copy link
Member
@psobolewskiPhD psobolewskiPhD commented Feb 28, 2025 •
edited
Loading

References and relevant issues

Closes #589

Description

In this PR, based on the discussion in the docs working group, see #589 (comment)

  1. remove requirements.txt
  2. remove the un-needed docs-install and docs elements in the Makefile
  3. Update the copy in the contributing guide to use napari[docs]:
  • explicitly specify that docs dependencies are in napari/napari pyproject.toml
  • directly provide napari[docs] installation instructions, along with a note on combining with a dev install.
  • remove mention of jupytext/jupyter in docs dependencies -- this appears outdated
  • add a note about jupytext in the admonition about using it to convert ipynb to md
  • switch to using make html and drop mention of make docs-install
  1. update the README for the changes.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 28, 2025
@psobolewskiPhD psobolewskiPhD added this to the 0.6.0 milestone Feb 28, 2025
willingc
willingc approved these changes Feb 28, 2025
View reviewed changes
Copy link
Contributor
@willingc willingc left a comment

Choose a reason for hiding this comment

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

Nice! Thanks @psobolewskiPhD

@psobolewskiPhD @willingc
Update docs/developers/contributing/documentation/index.md
909cd90 
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
TimMonko
TimMonko requested changes Mar 4, 2025
View reviewed changes
Copy link
Contributor
@TimMonko TimMonko left a comment

Choose a reason for hiding this comment

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

I followed the directions and (almost) built the docs locally successfully😄just a typical gallery build crash (OSError: exception: access violation reading 0x0000000000000034 make: *** [Makefile:31: docs-build] Error 127 , so not the fault of these directions.

I'm a bit confused about the jupytext bit, does that get installed with napari[docs]? it seems its an optional of myst-nb. So, just want to know if we need to clarify that jupytext would need to be separately installed for the conversion. I did not get jupyter or jupytext when pip install -e .[pyqt, dev, docs], so I think it would need to be separately added in.

ps. the build is so much quieter now ❤️ I got local back and working yesterday, but with the older install it was still pretty noisy in the console. With a fresh env things are way cleaner at the start

@psobolewskiPhD
Copy link
Member Author

Thanks @TimMonko
Yeah jupytext has never been in our docs dependencies because we don't actually use it. but it is a convenient tool for converting notebooks. It's used in our workshop template for example https://github.com/napari/napari-workshop-template/tree/main/napari-workshops
I changed the wording slightly to first say to install jupytext, then provide the command.

@psobolewskiPhD
Copy link
Member Author
psobolewskiPhD commented Mar 8, 2025 •
edited
Loading

Elephant in the room is that I can't build docs locally -- always seg fault.
(I really do suspect it must be related to napari/napari#7633)
But I do think everything is correct!

@psobolewskiPhD psobolewskiPhD reopened this Mar 8, 2025
@psobolewskiPhD
Copy link
Member Author

Rerunning CI post napari/napari#7676

@psobolewskiPhD
Copy link
Member Author
psobolewskiPhD commented Mar 8, 2025 •
edited
Loading

Regarding my local issues:
if I follow the guide and install [pyqt, docs] or [pyqt6, docs] then make html-noplot works.

melissawm
melissawm approved these changes Mar 8, 2025
View reviewed changes
Copy link
Member
@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

A couple of comments, otherwise looks good!

psobolewskiPhD
psobolewskiPhD commented Mar 8, 2025
View reviewed changes
@psobolewskiPhD @melissawm
Apply suggestions from code review by Melissa
ebfff55 
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
@psobolewskiPhD
Copy link
Member Author

Gah! build fail!

psobolewskiPhD
psobolewskiPhD commented Mar 8, 2025
View reviewed changes
psobolewskiPhD
psobolewskiPhD commented Mar 8, 2025
View reviewed changes
psobolewskiPhD
psobolewskiPhD commented Mar 8, 2025
View reviewed changes
melissawm
melissawm reviewed Mar 8, 2025
View reviewed changes
jni
jni approved these changes Mar 11, 2025
View reviewed changes
Copy link
Member
@jni jni left a comment

Choose a reason for hiding this comment

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

Awesome stuff @psobolewskiPhD 😍

@jni jni merged commit ee37235 into napari:main Mar 11, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@melissawm melissawm melissawm approved these changes

@jni jni jni approved these changes

@willingc willingc willingc approved these changes

@TimMonko TimMonko TimMonko approved these changes

Assignees

@psobolewskiPhD psobolewskiPhD

Labels
documentation Improvements or additions to documentation priority-high
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.

Use the docs napari dependency groups (docs, gallery) & add to contributing guide
5 participants
@psobolewskiPhD @jni @willingc @melissawm @TimMonko
0