From cfc8852864b6186a4d31837a9ecc56cae36678a2 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Sat, 19 Oct 2024 11:17:34 -0400 Subject: [PATCH 01/13] remove the custom guides navbar #10941 - restores the default "home" button for guides - restores "next" and "previous" links for each page - restores "source" button for each page (.rst or .md) --- .../source/_templates/navbar.html | 70 ------------------- 1 file changed, 70 deletions(-) delete mode 100644 doc/sphinx-guides/source/_templates/navbar.html diff --git a/doc/sphinx-guides/source/_templates/navbar.html b/doc/sphinx-guides/source/_templates/navbar.html deleted file mode 100644 index d88306be8ae..00000000000 --- a/doc/sphinx-guides/source/_templates/navbar.html +++ /dev/null @@ -1,70 +0,0 @@ -{# For dataverse.org SPHINX projects #} -{# Instructions: #} -{# (1) For a Sphinx project, copy the **contents** of this file into **navbar.html** #} -{# (2) Location of **navbar.html** within a SPHINX project: #} -{# - /source/_templates/**navbar.html** #} - - -
-
- -
- - Dataverse Project -
- - -
-
    -
  • - About -
      -
    • About the Project
    • -
    • Blog
    • -
    • Presentations
    • -
    • Publications
    • -
    -
  • -
  • - - Community - -
  • -
  • - Best Practices -
      -
    • Academic Credit
    • -
    • Data Citation
    • -
    • Dataverse Community Norms
    • -
    • Data Management
    • -
    • Replication Dataset Guidelines
    • -
    -
  • -
  • - Software -
      -
    • Features
    • -
    • Source Code
    • -
    • User Guide
    • -
    • Installation Guide
    • -
    • API Guide
    • -
    • Developer Guide
    • -
    • Style Guide
    • -
    • Admin Guide
    • -
    -
  • -
  • - - Contact - -
  • -
-
-
- -
From 5f308cd675de1e9a532718729bdcd891c907035a Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Sat, 19 Oct 2024 11:17:43 -0400 Subject: [PATCH 02/13] remove cruft from navbar about 3.6.2 guides #10941 This was hidden before because a custom navbar took over. --- doc/sphinx-guides/source/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/sphinx-guides/source/conf.py b/doc/sphinx-guides/source/conf.py index 7ee355302d8..ea29821b9bc 100755 --- a/doc/sphinx-guides/source/conf.py +++ b/doc/sphinx-guides/source/conf.py @@ -143,9 +143,6 @@ # ("Examples", "examples"), # ("Link", "http://example.com", True), # ], - 'navbar_links': [ - ("View 3.6.2 Guides", "http://docs.dataverse.org/en/3.6.2/", True), - ], # Global TOC depth for "site" navbar tab. (Default: 1) # Switching to -1 shows all levels. From 5c5812e9404633628bce9eb9d76fa495737a00df Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Thu, 24 Oct 2024 16:54:06 -0400 Subject: [PATCH 03/13] in navbar, add "About Dataverse" link to dataverse.org #10941 --- doc/sphinx-guides/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/sphinx-guides/source/conf.py b/doc/sphinx-guides/source/conf.py index ea29821b9bc..9d8d3ae8cdb 100755 --- a/doc/sphinx-guides/source/conf.py +++ b/doc/sphinx-guides/source/conf.py @@ -143,6 +143,9 @@ # ("Examples", "examples"), # ("Link", "http://example.com", True), # ], + 'navbar_links': [ + ("About Dataverse", "https://dataverse.org", True), + ], # Global TOC depth for "site" navbar tab. (Default: 1) # Switching to -1 shows all levels. From 9d935320fe050cc72665f05644d09c9ff73e773b Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 12:05:53 -0400 Subject: [PATCH 04/13] move "Source" link to footer #10941 --- doc/sphinx_bootstrap_theme/bootstrap/theme.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/theme.conf b/doc/sphinx_bootstrap_theme/bootstrap/theme.conf index 294eacb3be0..500f0ac7213 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/theme.conf +++ b/doc/sphinx_bootstrap_theme/bootstrap/theme.conf @@ -48,7 +48,7 @@ navbar_fixed_top = true # Location of link to source. # Options are "nav" (default), "footer" or anything else to exclude. -source_link_position = nav +source_link_position = footer # Bootswatch (http://bootswatch.com/) theme. # From 9a3a5858dd70da700bfd2b8e5fdd5620a585a925 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 12:12:17 -0400 Subject: [PATCH 05/13] link "v6.6" (or whatever) to versions.html --- doc/sphinx_bootstrap_theme/bootstrap/navbar.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html index 5c1d9b9b928..630ab0a5d29 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html @@ -13,7 +13,7 @@ {%- endblock %} {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%} - {{ version|e }} + v{{ version|e }}
From 79e59e3ab75d890ce48661a8c8d2bdc1447e3c66 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 12:14:32 -0400 Subject: [PATCH 06/13] comment out "prev" and "next" from navbar --- doc/sphinx_bootstrap_theme/bootstrap/navbar.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html index 630ab0a5d29..5c6a38cf470 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html @@ -31,7 +31,10 @@ {% endblock %} {% if theme_navbar_sidebarrel %} {% block sidebarrel %} + + {% endblock %} {% endif %} {% block navbarextra %} From 1c5f202885b34889aa8ab2e28874e92559c45897 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 12:18:16 -0400 Subject: [PATCH 07/13] comment out "Page" from navbar #10941 --- doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html b/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html index 8def043a6fe..0a8e0cbc9fb 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html @@ -1,9 +1,12 @@
  • + +
      {{ toc }}
    From 8e9d22affb327ef94b1b5985f862fdbbb373df30 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 12:24:20 -0400 Subject: [PATCH 08/13] add "Next" and "Previous" buttons to bottom of each page #10941 --- doc/sphinx_bootstrap_theme/bootstrap/layout.html | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/layout.html b/doc/sphinx_bootstrap_theme/bootstrap/layout.html index d3ccd463814..f58f082eaeb 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/layout.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/layout.html @@ -86,6 +86,22 @@ {%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
    {% block body %}{% endblock %} + + {%- if prev %} + + {%- if theme_bootstrap_version == "2" -%}{%- endif -%} + {%- if theme_bootstrap_version == "3" -%}{%- endif -%} + {{ "«Previous"|safe }} + + {%- endif %} + + {%- if next %} + + {%- if theme_bootstrap_version == "2" -%}{%- endif -%} + {%- if theme_bootstrap_version == "3" -%}{%- endif -%} + {{ "Next»"|safe }} + + {%- endif %}
    {% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
  • From dd53d50bb77dcbe3d8a596602915c9d8224c466f Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 24 Mar 2025 14:21:40 -0400 Subject: [PATCH 09/13] restore "Dataverse Project" and icon, remove cruft #10941 navbar_from_dataverse_org.js is no longer used, so we delete it. It operated on navbar.html, which we deleted already. The script was setting the site name to "Dataverse Project" and adding the Dataverse icon next to it. We're now doing this elsewhere. --- .../source/_static/docsdataverse_org.css | 13 +++++-------- .../_static/navbar_from_dataverse_org.js | 19 ------------------- .../bootstrap/navbar.html | 2 +- 3 files changed, 6 insertions(+), 28 deletions(-) delete mode 100644 doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js diff --git a/doc/sphinx-guides/source/_static/docsdataverse_org.css b/doc/sphinx-guides/source/_static/docsdataverse_org.css index 726abcc42bd..d861a788681 100755 --- a/doc/sphinx-guides/source/_static/docsdataverse_org.css +++ b/doc/sphinx-guides/source/_static/docsdataverse_org.css @@ -35,6 +35,10 @@ iframe { a.navbar-brand, a.navbar-brand:hover { color:#C55B28 !important; + height: 50px; + background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px; + line-height: 20px; + padding-left: 26px; } span.navbar-brand {color:#C55B28 !important; padding-left: 32px; height: 50px;} span.navbar-brand .icon-dataverse {color:#C55B28; font-size:28px; margin: -4px 0 0 -27px; position: absolute;} @@ -48,13 +52,6 @@ ul.navbar-nav li.dropdown.open > span.dropdown-toggle {background: #e7e7e7;} .text-dataset {color:#31708F;} .text-file {color:#777777;} -#dataverse-org-homepage-url { - height: 50px; - background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px; - line-height: 20px; - padding-left: 26px; -} - .navbar-default .navbar-nav > li > a { color: #303030 !important; } @@ -189,4 +186,4 @@ div.sphinx-tabs { li div.sphinx-tabs { padding-left: 0; -} \ No newline at end of file +} diff --git a/doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js b/doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js deleted file mode 100644 index 7432b63d38d..00000000000 --- a/doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js +++ /dev/null @@ -1,19 +0,0 @@ -/* - Use the HTML from the Dataverse.org navbar - See: https://github.com/IQSS/dataverse.org/tree/master/dataverse_org/templates/sphinx-navbar -*/ -function load_navbar(){ - //var navbar_url = 'http://127.0.0.1:8000/nav-only-json/?callback=?'; - //var navbar_url = 'http://beta.dataverse.org/nav-only-json/?callback=?'; - var navbar_url = 'http://dataverse.org/nav-only-json/?callback=?'; - - var jqxhr = $.getJSON( navbar_url, function(data) { - console.log( "success" ); - $('#dv-bs-navbar-details').html(data.navbar_html); - $("#dataverse-org-homepage-url").attr("href", data.dataverse_dot_org_homepage_url) - }) - .fail(function() { - console.log( "error" ); - $('#dv-bs-navbar-details').html(''); - }) -} \ No newline at end of file diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html index 5c6a38cf470..5c501bc2f28 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html @@ -11,7 +11,7 @@ {%- block sidebarlogo %} {%- if logo %}{%- endif %} {%- endblock %} - {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%} + {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}Dataverse Project{%- endif -%} v{{ version|e }} From 15aa3805a20d2cc25e9aebfa11579efe749b50f0 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 28 Mar 2025 09:24:17 -0400 Subject: [PATCH 10/13] comment out Site --- doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html b/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html index d5df46c60d5..aa1d860a924 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html @@ -1,9 +1,12 @@
  • + +
      {{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
    From 7168d50189d5aed6a7f7c784ee302fa23128cf77 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 28 Mar 2025 12:59:36 -0400 Subject: [PATCH 11/13] add release note #10941 --- doc/release-notes/10941-remove-custom-guides-navbar.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/release-notes/10941-remove-custom-guides-navbar.md diff --git a/doc/release-notes/10941-remove-custom-guides-navbar.md b/doc/release-notes/10941-remove-custom-guides-navbar.md new file mode 100644 index 00000000000..69251af1649 --- /dev/null +++ b/doc/release-notes/10941-remove-custom-guides-navbar.md @@ -0,0 +1 @@ +Navigation across the guides has been improved. You can now click in the upper left to go "home". The navbar has been simplified with fewer links. The bottom of every page now has "Next" and "Previous" links. A "Source" link at the bottom has also been added. See #10942. From deadddf69e693bf9c93a45ea70c1e4fba21109ea Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Tue, 8 Apr 2025 14:50:25 -0400 Subject: [PATCH 12/13] right align the "Next" button #10941 --- doc/sphinx_bootstrap_theme/bootstrap/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/layout.html b/doc/sphinx_bootstrap_theme/bootstrap/layout.html index f58f082eaeb..3a8bc9330eb 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/layout.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/layout.html @@ -96,7 +96,7 @@ {%- endif %} {%- if next %} - + {%- if theme_bootstrap_version == "2" -%}{%- endif -%} {%- if theme_bootstrap_version == "3" -%}{%- endif -%} {{ "Next»"|safe }} From 4bbb21cede6eaeecdd922b95f25fc8fe9cd11145 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 14 Apr 2025 11:52:59 -0400 Subject: [PATCH 13/13] put Dataverse Guides at top instead of Dataverse Project #10941 --- doc/sphinx_bootstrap_theme/bootstrap/navbar.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html index 5c501bc2f28..f04d8742f54 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html @@ -11,7 +11,7 @@ {%- block sidebarlogo %} {%- if logo %}{%- endif %} {%- endblock %} - {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}Dataverse Project{%- endif -%} + {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}Dataverse Guides{%- endif -%} v{{ version|e }}