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 release notes and community chat links to homepage sidebar #610

Merged
merged 3 commits into from
Mar 9, 2025
Merged

Add release notes and community chat links to homepage sidebar #610

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
8fce647
rename sidebar links file; add chat and release notes
TimMonko Mar 2, 2025
70636e2
try linking to release notes of current version
TimMonko Mar 2, 2025
205e3a2
fix index reference
TimMonko Mar 3, 2025
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
9 changes: 0 additions & 9 deletions docs/_templates/calendar-template.html
View file
Open in desktop

This file was deleted.

19 changes: 19 additions & 0 deletions docs/_templates/sidebar-link-items.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<nav class="bd-docs-nav bd-links">
Copy link
Contributor

Choose a reason for hiding this comment

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

I think making this change in the napari-sphinx-theme is likely a better place for these changes.

Copy link
Member

Choose a reason for hiding this comment

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

Either way would be fine - I understand @TimMonko' s argument about these links being specific to our pages but we have a bunch of napari-specific items in the theme as well 🤷🏻

<div class="bd-toc-item navbar-nav">
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="community/meeting_schedule.html">Community calendar</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://napari.zulipchat.com/">Community chat</a>
</li>
<li class="toctree-l1">
{% if version == "dev" %}
<a class="reference internal" href="{{ 'release/index.html' }}">Release notes</a>
{% else %}
<a class="reference internal" href="{{ 'release/release_' + version.replace('.', '_') + '.html' }}">Latest release notes</a>
{% endif %}
</li>
</ul>
</div>
</nav>
7 changes: 5 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,15 @@

html_sidebars = {
"**": ["search-field.html", "sidebar-nav-bs"],
"index": ["search-field.html" , "calendar-template"],
"index": ["search-field.html" , "sidebar-link-items.html"],
}

html_context = {
# use Light theme only, don't auto switch (default)
"default_mode": "light"
"default_mode": "light",
# add release version to context
"release": release,
"version": version,
}

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