From af25b541509b2260ceb3ffbbd79ed76c6d5a8284 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Thu, 18 Jan 2024 15:51:34 -0500
Subject: [PATCH 01/13] test announcement
---
docs/conf.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/conf.py b/docs/conf.py
index 6c70bd64..9698cc2b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -110,6 +110,7 @@
"secondary_sidebar_items": ["page-toc"],
"pygment_light_style": "napari",
"pygment_dark_style": "napari",
+ "announcement": "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html",
}
# Add any paths that contain custom static files (such as style sheets) here,
From 5c16b6f02955c400b3b354d3d19fb0cf9123aafb Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Thu, 18 Jan 2024 16:14:50 -0500
Subject: [PATCH 02/13] Try a napari message
---
docs/_templates/custom-template.html | 6 ++++++
docs/conf.py | 2 +-
2 files changed, 7 insertions(+), 1 deletion(-)
create mode 100644 docs/_templates/custom-template.html
diff --git a/docs/_templates/custom-template.html b/docs/_templates/custom-template.html
new file mode 100644
index 00000000..d23e586f
--- /dev/null
+++ b/docs/_templates/custom-template.html
@@ -0,0 +1,6 @@
+
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 9698cc2b..c8cb44a3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -110,7 +110,7 @@
"secondary_sidebar_items": ["page-toc"],
"pygment_light_style": "napari",
"pygment_dark_style": "napari",
- "announcement": "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html",
+ "announcement": "https://raw.githubusercontent.com/napari/docs/main/docs/_templates/custom-template.html",
}
# Add any paths that contain custom static files (such as style sheets) here,
From 57197422b702c1abc0414c8691c605e88c514fe6 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Thu, 18 Jan 2024 16:34:34 -0500
Subject: [PATCH 03/13] Use temp path in my repo
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index c8cb44a3..d6df0a2e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -110,7 +110,7 @@
"secondary_sidebar_items": ["page-toc"],
"pygment_light_style": "napari",
"pygment_dark_style": "napari",
- "announcement": "https://raw.githubusercontent.com/napari/docs/main/docs/_templates/custom-template.html",
+ "announcement": "https://raw.githubusercontent.com/psobolewskiPhD/napari-docs/announcement/docs/_templates/custom-template.html",
}
# Add any paths that contain custom static files (such as style sheets) here,
From 00965432eaf657e84c73b21bf2ae4d3ee9d836fe Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Sat, 20 Jan 2024 12:07:49 -0500
Subject: [PATCH 04/13] test with annoucement file present but empty.
---
docs/_templates/announcement.bak | 6 ++++++
docs/_templates/custom-template.html | 6 ------
2 files changed, 6 insertions(+), 6 deletions(-)
create mode 100644 docs/_templates/announcement.bak
diff --git a/docs/_templates/announcement.bak b/docs/_templates/announcement.bak
new file mode 100644
index 00000000..d23e586f
--- /dev/null
+++ b/docs/_templates/announcement.bak
@@ -0,0 +1,6 @@
+
\ No newline at end of file
diff --git a/docs/_templates/custom-template.html b/docs/_templates/custom-template.html
index d23e586f..e69de29b 100644
--- a/docs/_templates/custom-template.html
+++ b/docs/_templates/custom-template.html
@@ -1,6 +0,0 @@
-
\ No newline at end of file
From 5878d223177781a06fafb01322ab29751a477659 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski
Date: Tue, 23 Jan 2024 08:05:19 -0500
Subject: [PATCH 05/13] Revert "test with annoucement file present but empty."
This reverts commit 00965432eaf657e84c73b21bf2ae4d3ee9d836fe.
---
docs/_templates/announcement.bak | 6 ------
docs/_templates/custom-template.html | 6 ++++++
2 files changed, 6 insertions(+), 6 deletions(-)
delete mode 100644 docs/_templates/announcement.bak
diff --git a/docs/_templates/announcement.bak b/docs/_templates/announcement.bak
deleted file mode 100644
index d23e586f..00000000
--- a/docs/_templates/announcement.bak
+++ /dev/null
@@ -1,6 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/_templates/custom-template.html b/docs/_templates/custom-template.html
index e69de29b..d23e586f 100644
--- a/docs/_templates/custom-template.html
+++ b/docs/_templates/custom-template.html
@@ -0,0 +1,6 @@
+
\ No newline at end of file
From 62e8a0adc90eada5ff26a82f9234f753f89478a4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?=
Date: Sun, 28 Jan 2024 17:15:55 -0300
Subject: [PATCH 06/13] Fix announcement banner color for dark mode
---
docs/_static/custom.css | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
index 9bc02cb7..e07a2e4e 100644
--- a/docs/_static/custom.css
+++ b/docs/_static/custom.css
@@ -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;
+}
From ca3ac52fb0ff5f2016fdffabf3e7b620dcd17fce Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:07:32 -0500
Subject: [PATCH 07/13] add comment to custom-template.html
---
docs/_templates/custom-template.html | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/docs/_templates/custom-template.html b/docs/_templates/custom-template.html
index d23e586f..b639bc39 100644
--- a/docs/_templates/custom-template.html
+++ b/docs/_templates/custom-template.html
@@ -1,6 +1,10 @@
+
\ No newline at end of file
+
From 7bb304d179c14022fe0be4fa9aac0fe023f033a4 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:20:17 -0500
Subject: [PATCH 08/13] Use text announcement in conf.py
---
docs/conf.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index d6df0a2e..298c5e77 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -110,7 +110,10 @@
"secondary_sidebar_items": ["page-toc"],
"pygment_light_style": "napari",
"pygment_dark_style": "napari",
- "announcement": "https://raw.githubusercontent.com/psobolewskiPhD/napari-docs/announcement/docs/_templates/custom-template.html",
+ # 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.",
+ # 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/custom-template.html",
}
# Add any paths that contain custom static files (such as style sheets) here,
From 975536a6f772f5d7e62c0dc63746a12a2d7e756b Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:20:58 -0500
Subject: [PATCH 09/13] Rename custom-template.html to
announcement-template.html
---
.../{custom-template.html => announcement-template.html} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename docs/_templates/{custom-template.html => announcement-template.html} (100%)
diff --git a/docs/_templates/custom-template.html b/docs/_templates/announcement-template.html
similarity index 100%
rename from docs/_templates/custom-template.html
rename to docs/_templates/announcement-template.html
From 37a9fcbdbc908a13ca53ab7996784e7f1d4387f7 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:21:34 -0500
Subject: [PATCH 10/13] Use announcement-template.html as filename
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 298c5e77..25f3f48f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -113,7 +113,7 @@
# 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.",
# 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/custom-template.html",
+ # "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,
From 4d71a5db25f4b3d61c6d30c349d2721840211663 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:33:29 -0500
Subject: [PATCH 11/13] Update announcement-template.html to point to dev
contributing
---
docs/_templates/announcement-template.html | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/docs/_templates/announcement-template.html b/docs/_templates/announcement-template.html
index b639bc39..9b49e93f 100644
--- a/docs/_templates/announcement-template.html
+++ b/docs/_templates/announcement-template.html
@@ -3,8 +3,7 @@
html_theme_options section of conf.py using the key: "announcement"
-->
From 0a79c31f31e680f2bfcc2f6464ac1697668c2b17 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 10:52:48 -0500
Subject: [PATCH 12/13] Update text announcement to link to dev contributing
guide
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 25f3f48f..7803527d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -111,7 +111,7 @@
"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.",
+ "announcement": "This is a community-supported project! There's many ways to contribute, check out our Contributing guide.",
# 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",
}
From 11c471df38595a41c3102520fb5fe16de535ca8a Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Tue, 30 Jan 2024 11:11:04 -0500
Subject: [PATCH 13/13] fix quotes in link in conf.py
---
docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 7803527d..d6f9f0c5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -111,7 +111,7 @@
"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, check out our Contributing guide.",
+ "announcement": "This is a community-supported project! There's many ways to contribute, check out our Contributing guide.",
# 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",
}