Skip to content

Conversation

@TimMonko
Copy link
Contributor

References and relevant issues

Follow-up to #881

Description

While reading through the new quickstart, I noticed this mention of an un-maintained plugin. For a while, the plugin did not work, but I do think it does appear to be fixed now MouseLand/cellpose-napari#51 (comment)

I propose we remove this very small mention.

We can consider adding back plugins once we have our review system in place. My preference would be for us to make a "starter plugins" guide, rather than a short quip (that's hard to notice because of its placement!) in this quick start. There already is good detail here pointing people towards the hub :)

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 13, 2026
@TimMonko
Copy link
Contributor Author

? not sure I understand the fail. I don't see anything useful in the circleci output

@psobolewskiPhD
Copy link
Member

I don't have time right now, but here's my process:
search for warning
then google the warning
image

@TimMonko
Copy link
Contributor Author

Yeah I did but that's irrelevant to my PR, right?I assume its about the mermaid's but I dont get it

@melissawm
Copy link
Member

melissawm commented Jan 13, 2026

sphinxcontrib-mermaid had a new release with breaking changes, and we don't pin it. So you need to change this line

https://github.com/napari/docs/blob/1f9759bc61c0697cdbf9f805e334dbbc4b2fca28/docs/conf.py#L200C1-L200C25

to read

mermaid_include_elk = False

and the build works (tested locally)

You can see the config value here: https://sphinxcontrib-mermaid-demo.readthedocs.io/en/stable/ (old version) and here https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/#mermaid-include-elk (new version)

@psobolewskiPhD
Copy link
Member

We do have constraints though, so if this is due to a package update, then this suggests they aren't working properly.

@melissawm
Copy link
Member

Well, it looks like we should be using the constraints:

PIP_CONSTRAINT: napari/resources/constraints/constraints_py3.12_docs.txt

which do pin sphinxcontrib-mermaid https://github.com/napari/napari/blob/326d0144b22b7808cd16dfeb49c48590d94869d9/resources/constraints/constraints_py3.12_docs.txt#L710

But this doesn't take effect in circleci, so sphinxcontrib-mermaid which is not pinned here https://github.com/napari/napari/blob/326d0144b22b7808cd16dfeb49c48590d94869d9/pyproject.toml#L197 is installed to the latest version 😬

Maybe uv doesn't take in to account the PIP_CONSTRAINTS argument? https://app.circleci.com/pipelines/github/napari/docs/1752/workflows/adef5c30-e6be-41c9-9701-1d9caa83e8c2/jobs/1753?invite=true#step-106-3450_31

@TimMonko
Copy link
Contributor Author

@Czaki

@psobolewskiPhD
Copy link
Member

Yeah it's something like that, but not quite because here's the GA run which has the older version, so presumably from constraints and it's also uv
https://github.com/napari/docs/actions/runs/20971807220/job/60276799171?pr=908#step:7:259

@psobolewskiPhD
Copy link
Member

If you look at the working action it uses:
https://github.com/napari/shared-workflows/blob/b5f068979222e2929547fc42226bd83122be4568/.github/workflows/build_docs.yml#L72

PR Inc.

TimMonko pushed a commit that referenced this pull request Jan 13, 2026
# References and relevant issues
Circle CI docs not using constraints:
#908 (comment)

# Description
Looks like UV isn't using the PIP env var.
This uses the UV one.
@TimMonko
Copy link
Contributor Author

@psobolewskiPhD and @melissawm true 🧙s
thanks friends 🥳

@TimMonko TimMonko added this to the 0.7.0 milestone Jan 13, 2026
@melissawm melissawm merged commit f82d16a into napari:main Jan 14, 2026
10 checks passed
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 ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants