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.

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

Add placeholder announcement and html file for announcements #332

Closed
wants to merge 14 commits into from
Closed

Add placeholder announcement and html file for announcements #332

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
af25b54
test announcement
psobolewskiPhD Jan 18, 2024
5c16b6f
Try a napari message
psobolewskiPhD Jan 18, 2024
5719742
Use temp path in my repo
psobolewskiPhD Jan 18, 2024
0096543
test with annoucement file present but empty.
psobolewskiPhD Jan 20, 2024
5878d22
Revert "test with annoucement file present but empty."
psobolewskiPhD Jan 23, 2024
62e8a0a
Fix announcement banner color for dark mode
melissawm Jan 28, 2024
99bce71
Merge pull request #10 from melissawm/fix-color
psobolewskiPhD Jan 28, 2024
ca3ac52
add comment to custom-template.html
psobolewskiPhD Jan 30, 2024
7bb304d
Use text announcement in conf.py
psobolewskiPhD Jan 30, 2024
975536a
Rename custom-template.html to announcement-template.html
psobolewskiPhD Jan 30, 2024
37a9fcb
Use announcement-template.html as filename
psobolewskiPhD Jan 30, 2024
4d71a5d
Update announcement-template.html to point to dev contributing
psobolewskiPhD Jan 30, 2024
0a79c31
Update text announcement to link to dev contributing guide
psobolewskiPhD Jan 30, 2024
11c471d
fix quotes in link in conf.py
psobolewskiPhD Jan 30, 2024
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
5 changes: 5 additions & 0 deletions docs/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,8 @@ div.sphx-glr-download a:hover {
background-image: none;
background-color: #ffffff !important;
}

/* Workaround for announcement banner */
html[data-theme="dark"] {
--pst-color-secondary-bg: #e0c7ff;
}
10 changes: 10 additions & 0 deletions docs/_templates/announcement-template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!-- This will appear in the announcement banner at the top
It needs to be activated by passing the link in
html_theme_options section of conf.py using the key: "announcement"
-->
<div class="sidebar-message">
This is a community-supported project.
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to add the survey text and link already?

Copy link
Member Author

Choose a reason for hiding this comment

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

We could, I was sort of thinking of making this a placeholder and then making a survey PR just for better history

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah thinking more, I think it's better we have a default/placeholder announcement and then we PR the survey one as needed--and we have something to go back to.

Copy link
Member

Choose a reason for hiding this comment

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

ok sounds good!

If you'd like to contribute,
<a href="https://github.com/napari/napari">check out our GitHub repository.</a>
Your contributions are welcome!
</div>
4 changes: 4 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@
"secondary_sidebar_items": ["page-toc"],
"pygment_light_style": "napari",
"pygment_dark_style": "napari",
# hard coded announcement for banner at the top:
"announcement": "This is a community-supported project! There's many ways to contribute—click Contributing below for info.",
Copy link
Member

Choose a reason for hiding this comment

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

And here as well, we could add the survey text and link.

Copy link
Member Author

Choose a reason for hiding this comment

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

As noted above, I think it's best to just have a placeholder announcement here and then we PR the survey as needed. The only question is where to keep this one plain text like I did or put in a link to dev/contributing docs -- sneaky way around the versioned docs!

Copy link
Member Author

Choose a reason for hiding this comment

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

lets try the link

# Below uses a linked file, making it possible to edit the announcement without a release/rebuilding docs
# "announcement": "https://raw.githubusercontent.com/napari/docs/blob/main/docs/_templates/announcement-template.html",
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
Loading