Skip to content

Add themes contribution to plugin building guides #1027

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

Open
TimMonko wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add themes contribution to plugin building guides #1027

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a20787
add themes guide
TimMonko May 20, 2026
43c5602
add stub for theme guide
TimMonko May 20, 2026
c0fac46
fix build warning with stubs by adding new lines
TimMonko May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/_scripts/prep_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,12 @@ def main(stubs=False):
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

@psobolewskiPhD psobolewskiPhD May 25, 2026

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

@TimMonko TimMonko May 25, 2026

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

@psobolewskiPhD psobolewskiPhD May 25, 2026

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

@Czaki Czaki May 25, 2026

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.

'plugins/_npe2_widgets_guide.md': '(widgets-contribution-guide)=\n',
'plugins/_npe2_menus_guide.md': '(menus-contribution-guide)=\n',
'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

@psobolewskiPhD psobolewskiPhD May 22, 2026

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?

}
for doc, target in plugin_docs.items():
file_path = DOCS / doc
Expand Down
5 changes: 5 additions & 0 deletions docs/plugins/building_a_plugin/guides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ ______________________________________________________________________

______________________________________________________________________

```{include} ../_npe2_themes_guide.md
```

______________________________________________________________________

```{include} ../_npe2_sample_data_guide.md
```

Expand Down
Loading