ci: fixing baseurl (#395)

* ci: fixing baseurl

Signed-off-by: Henry Schreiner <[email protected]>

* fix: remove baseurl (Jekyll 4 adds it)

Signed-off-by: Henry Schreiner <[email protected]>

* fix: make sure permalinks have trailing slash

Signed-off-by: Henry Schreiner <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Signed-off-by: Henry Schreiner <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: henryiii

.readthedocs.yaml

@@ -16,5 +16,4 @@ build:
     - bundle install
     - >
       JEKYLL_ENV=production bundle exec jekyll build --destination
-      _readthedocs/html --baseurl $(echo -n "$READTHEDOCS_CANONICAL_URL" | cut
-      -d '/' -f 4-)
+      _readthedocs/html --baseurl $(echo -n "$READTHEDOCS_CANONICAL_URL" | cut -d '/' -f 4-)

Gemfile

@@ -2,6 +2,8 @@
 
 source 'https://rubygems.org'
 
+ruby '>= 3.1'
+
 # Hello! This is where you manage which Jekyll version is used to run.
 # When you want to use a different version, change it below, save the
 # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
@@ -20,12 +22,18 @@ gem 'kramdown-parser-gfm'
 # gem 'just-the-docs'
 gem 'rake'
 
+# Used to be in the stdlib
+gem 'logger'
+
+# This is the theme
+gem "just-the-docs"
+
 # If you have any plugins, put them here!
 group :jekyll_plugins do
   gem 'jekyll-feed'
   gem 'jekyll-redirect-from'
-  gem 'jekyll-remote-theme'
   gem 'jekyll-seo-tag'
+  gem 'jekyll-sass-converter', '~> 3.1.0'
 end
 
 # Checkers and such

Gemfile.lock

@@ -89,20 +89,22 @@ GEM
       webrick (~> 1.7)
     jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
     jekyll-redirect-from (0.16.0)
       jekyll (>= 3.3, < 5.0)
-    jekyll-remote-theme (0.4.3)
-      addressable (~> 2.0)
-      jekyll (>= 3.5, < 5.0)
-      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
-      rubyzip (>= 1.3.0, < 3.0)
-    jekyll-sass-converter (3.0.0)
-      sass-embedded (~> 1.54)
+    jekyll-sass-converter (3.1.0)
+      sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     json (2.9.1)
+    just-the-docs (0.10.1)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
@@ -111,6 +113,7 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.4)
     mercenary (0.4.0)
     metrics (0.12.1)
     nokogiri (1.18.2-aarch64-linux-gnu)
@@ -147,7 +150,6 @@ GEM
     rexml (3.4.0)
     rouge (4.5.1)
     ruby-rc4 (0.1.5)
-    rubyzip (2.4.1)
     safe_yaml (1.0.5)
     sass-embedded (1.83.4-aarch64-linux-gnu)
       google-protobuf (~> 4.29)
@@ -196,12 +198,17 @@ DEPENDENCIES
   jekyll
   jekyll-feed
   jekyll-redirect-from
-  jekyll-remote-theme
+  jekyll-sass-converter (~> 3.1.0)
   jekyll-seo-tag
+  just-the-docs
   kramdown-parser-gfm
+  logger
   rake
   tzinfo-data
   webrick
 
+RUBY VERSION
+   ruby 3.4.1p0
+
 BUNDLED WITH
-   2.5.22
+   2.6.2

_config.yml

@@ -5,14 +5,10 @@ description: >-
   project with the aim of providing Particle Physics at large with an
   ecosystem for data analysis in Python. The project started in Autumn
   2016 and is under active development.
-baseurl: ""
-url: "https://scikit-hep.org"
 github_username: scikit-hep
-
 # Build settings
 markdown: kramdown
-# Local: theme: "just-the-docs"
-remote_theme: "just-the-docs/[email protected]"
+theme: "just-the-docs"
 plugins:
   - jekyll-feed
 
@@ -60,3 +56,8 @@ callouts:
     title: Important
   highlight:
     color: blue
+
+# SASS 3 will make stuff break
+sass:
+  quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
+  silence_deprecations: ["import"] # https://github.com/just-the-docs/just-the-docs/issues/1607

_includes/package_table.html

@@ -15,7 +15,7 @@ <h3 id="{{cat.name}}">{{cat.title}}:</h3>
     <a href="{{project.url}}" class="logo">
       <img
         style="{{ project.projlogo-style | default: 'height:48px;'}}"
-        src="{{site.baseurl}}{{ project.projlogo | link }}"
+        src="{{ project.projlogo | relative_url }}"
         alt="{{project.name}} logo"
       />
     </a>

index.md

@@ -8,19 +8,19 @@ nav_order: 1
 
 The Scikit-HEP project is a community-driven and community-oriented project
 with the aim of providing Particle Physics at large with an ecosystem for data
-analysis in Python. [Read more →]({{site.baseurl}}{% link pages/about/index.md %})
+analysis in Python. [Read more →]({% link pages/about/index.md %})
 
 New users can start with our
-[user pages]({{site.baseurl}}{% link pages/user/index.md %}). See our
-[developer pages]({{site.baseurl}}{% link pages/developers/index.md %})
+[user pages]({% link pages/user/index.md %}). See our
+[developer pages]({% link pages/developers/index.md %})
 for information on developing Python packages.
 
 <div markdown="1" class="text-center text-delta fs-3">
-[News]({{site.baseurl}}{% link pages/news.md %}) •
+[News]({% link pages/news.md %}) •
 [Tutorial](https://hsf-training.github.io/hsf-training-scikit-hep-webpage/) •
-[Resources]({{site.baseurl}}{% link pages/user/resources.md %}) •
-[Cite us]({{site.baseurl}}{% link pages/about/citing.md %}) •
-[Get in touch]({{site.baseurl}}{% link pages/user/getting-in-touch.md %})
+[Resources]({% link pages/user/resources.md %}) •
+[Cite us]({% link pages/about/citing.md %}) •
+[Get in touch]({% link pages/user/getting-in-touch.md %})
 </div>
 
 {% include package_table.html %}
@@ -34,4 +34,4 @@ stack. If you are looking for a deprecated package, see the [full package list][
 [gitter-skhep-link]: https://gitter.im/Scikit-HEP/community
 [gitter-skhep-badge]: https://badges.gitter.im/Scikit-HEP/community.svg
 
-[full package list]: {{site.baseurl}}{% link pages/packages/index.md %}
+[full package list]: {% link pages/packages/index.md %}

pages/about/citing.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Citing Scikit-HEP
-permalink: /citing
+permalink: /citing/
 nav_order: 1
 parent: About
 custom_title: Citing Scikit-HEP or individual packages

pages/about/code-of-conduct.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Code of conduct
-permalink: /code-of-conduct
+permalink: /code-of-conduct/
 nav_order: 1
 parent: About
 custom_title: Contributor covenant code of conduct

pages/about/faq.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: FAQ
-permalink: /faq
+permalink: /faq/
 nav_order: 4
 parent: About
 ---

pages/about/funding.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Funding
-permalink: /funding
+permalink: /funding/
 nav_order: 9
 parent: About
 ---
@@ -34,9 +34,9 @@ provide funding for Eduardo Rodrigues (2020-) to work on this project part-time.
 [oac-1450377]: https://nsf.gov/awardsearch/showAward?AWD_ID=1450377
 [oac-1836650]: https://nsf.gov/awardsearch/showAward?AWD_ID=1836650
 
-[img-nsf]: {{ site.baseurl }}{% link /assets/images/funding/nsf-logo-128.png %}
+[img-nsf]: {% link /assets/images/funding/nsf-logo-128.png %}
 {: width="70px"}
-[img-stfc]: {{ site.baseurl }}{% link /assets/images/funding/UKRI_STF_Council-Logo_Horiz-RGB.png %}
+[img-stfc]: {% link /assets/images/funding/UKRI_STF_Council-Logo_Horiz-RGB.png %}
 {: width="140px"}
-[img-liverpool]: {{ site.baseurl }}{% link /assets/images/funding/university-liverpool-logo.png %}
+[img-liverpool]: {% link /assets/images/funding/university-liverpool-logo.png %}
 {: width="140px"}