Skip to content

Add themes contribution to plugin building guides#1027

Open
TimMonko wants to merge 3 commits into
napari:mainfrom
TimMonko:add-theme-contrib
Open

Add themes contribution to plugin building guides#1027
TimMonko wants to merge 3 commits into
napari:mainfrom
TimMonko:add-theme-contrib

Conversation

@TimMonko
Copy link
Copy Markdown
Contributor

References and relevant issues

Discovered while debugging napari/napari-shpinx-theme#228

Description

Adds theme contribution to guide. I think its good and ready after napari/npe2#465

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 20, 2026
@TimMonko
Copy link
Copy Markdown
Contributor Author

@napari-bot make docs

@TimMonko TimMonko added this to the 0.7.1 milestone May 21, 2026
Copy link
Copy Markdown
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

:shipit:

'plugins/_npe2_manifest.md': '# Manifest Reference\n',
'plugins/_npe2_writers_guide.md': '(writers-contribution-guide)=\n',
'plugins/_npe2_contributions.md': '# Contributions Reference\n(contributions-themes)=\n(contributions-commands)=\n(contributions-widgets)=\n(contributions-readers)=\n(contributions-writers)=\n(contributions-sample-data)=\n(layer-type-constraints)=\n',
'plugins/_npe2_contributions.md': '# Contributions Reference\n\n(contributions-themes)=\n\n(contributions-commands)=\n\n(contributions-widgets)=\n\n(contributions-readers)=\n\n(contributions-writers)=\n\n(contributions-sample-data)=\n\n(layer-type-constraints)=\n',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why do we need these extra \n? is this a windows thing?

@psobolewskiPhD
Copy link
Copy Markdown
Member

@napari-bot make html

@Czaki
Copy link
Copy Markdown
Contributor

Czaki commented May 25, 2026

Is this pending on next npe2? release?

@psobolewskiPhD
Copy link
Copy Markdown
Member

The fail is real, but yeah maybe it needs npe2 release?

/home/circleci/project/docs/docs/plugins/building_a_plugin/guides.md:33: CRITICAL: Directive "include": file not found: '/home/circleci/project/docs/docs/plugins/_npe2_themes_guide.md' [docutils]

plugin_docs = {
'plugins/_npe2_sample_data_guide.md': '(sample-data-contribution-guide)=\n',
'plugins/_npe2_readers_guide.md': '(readers-contribution-guide)=\n',
'plugins/_npe2_themes_guide.md': '(themes-contribution-guide)=\n',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Something is off, there is no template for this guidein npe2 repo:
https://github.com/napari/npe2/tree/23ca363d681e1393914d86b803dd4adf091d78f2/_docs/templates

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Weird.... It builds for me locally. Maybe I accidentally have a change in my local npe2 that I forgot about

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Are you sure you're building a guide and not just a stub?
I don't see an actual guide in npe2 repo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I checked. This way requires npe2 contribution and release.

@Czaki Czaki removed this from the 0.7.1 milestone May 25, 2026
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

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants