Skip to content

Commit d38795b

Browse files
henryiiipre-commit-ci[bot]
henryiii
and
pre-commit-ci[bot]
authored
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>
1 parent cc178e0 commit d38795b

39 files changed

+108
-93
lines changed

‎.readthedocs.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@ build:
1616
- bundle install
1717
- >
1818
JEKYLL_ENV=production bundle exec jekyll build --destination
19-
_readthedocs/html --baseurl $(echo -n "$READTHEDOCS_CANONICAL_URL" | cut
20-
-d '/' -f 4-)
19+
_readthedocs/html --baseurl $(echo -n "$READTHEDOCS_CANONICAL_URL" | cut -d '/' -f 4-)

‎Gemfile

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
source 'https://rubygems.org'
44

5+
ruby '>= 3.1'
6+
57
# Hello! This is where you manage which Jekyll version is used to run.
68
# When you want to use a different version, change it below, save the
79
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
@@ -20,12 +22,18 @@ gem 'kramdown-parser-gfm'
2022
# gem 'just-the-docs'
2123
gem 'rake'
2224

25+
# Used to be in the stdlib
26+
gem 'logger'
27+
28+
# This is the theme
29+
gem "just-the-docs"
30+
2331
# If you have any plugins, put them here!
2432
group :jekyll_plugins do
2533
gem 'jekyll-feed'
2634
gem 'jekyll-redirect-from'
27-
gem 'jekyll-remote-theme'
2835
gem 'jekyll-seo-tag'
36+
gem 'jekyll-sass-converter', '~> 3.1.0'
2937
end
3038

3139
# Checkers and such

‎Gemfile.lock

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,22 @@ GEM
8989
webrick (~> 1.7)
9090
jekyll-feed (0.17.0)
9191
jekyll (>= 3.7, < 5.0)
92+
jekyll-include-cache (0.2.1)
93+
jekyll (>= 3.7, < 5.0)
9294
jekyll-redirect-from (0.16.0)
9395
jekyll (>= 3.3, < 5.0)
94-
jekyll-remote-theme (0.4.3)
95-
addressable (~> 2.0)
96-
jekyll (>= 3.5, < 5.0)
97-
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
98-
rubyzip (>= 1.3.0, < 3.0)
99-
jekyll-sass-converter (3.0.0)
100-
sass-embedded (~> 1.54)
96+
jekyll-sass-converter (3.1.0)
97+
sass-embedded (~> 1.75)
10198
jekyll-seo-tag (2.8.0)
10299
jekyll (>= 3.8, < 5.0)
103100
jekyll-watch (2.2.1)
104101
listen (~> 3.0)
105102
json (2.9.1)
103+
just-the-docs (0.10.1)
104+
jekyll (>= 3.8.5)
105+
jekyll-include-cache
106+
jekyll-seo-tag (>= 2.0)
107+
rake (>= 12.3.1)
106108
kramdown (2.5.1)
107109
rexml (>= 3.3.9)
108110
kramdown-parser-gfm (1.1.0)
@@ -111,6 +113,7 @@ GEM
111113
listen (3.9.0)
112114
rb-fsevent (~> 0.10, >= 0.10.3)
113115
rb-inotify (~> 0.9, >= 0.9.10)
116+
logger (1.6.4)
114117
mercenary (0.4.0)
115118
metrics (0.12.1)
116119
nokogiri (1.18.2-aarch64-linux-gnu)
@@ -147,7 +150,6 @@ GEM
147150
rexml (3.4.0)
148151
rouge (4.5.1)
149152
ruby-rc4 (0.1.5)
150-
rubyzip (2.4.1)
151153
safe_yaml (1.0.5)
152154
sass-embedded (1.83.4-aarch64-linux-gnu)
153155
google-protobuf (~> 4.29)
@@ -196,12 +198,17 @@ DEPENDENCIES
196198
jekyll
197199
jekyll-feed
198200
jekyll-redirect-from
199-
jekyll-remote-theme
201+
jekyll-sass-converter (~> 3.1.0)
200202
jekyll-seo-tag
203+
just-the-docs
201204
kramdown-parser-gfm
205+
logger
202206
rake
203207
tzinfo-data
204208
webrick
205209

210+
RUBY VERSION
211+
ruby 3.4.1p0
212+
206213
BUNDLED WITH
207-
2.5.22
214+
2.6.2

‎_config.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,10 @@ description: >-
55
project with the aim of providing Particle Physics at large with an
66
ecosystem for data analysis in Python. The project started in Autumn
77
2016 and is under active development.
8-
baseurl: ""
9-
url: "https://scikit-hep.org"
108
github_username: scikit-hep
11-
129
# Build settings
1310
markdown: kramdown
14-
# Local: theme: "just-the-docs"
15-
remote_theme: "just-the-docs/[email protected]"
11+
theme: "just-the-docs"
1612
plugins:
1713
- jekyll-feed
1814

@@ -60,3 +56,8 @@ callouts:
6056
title: Important
6157
highlight:
6258
color: blue
59+
60+
# SASS 3 will make stuff break
61+
sass:
62+
quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
63+
silence_deprecations: ["import"] # https://github.com/just-the-docs/just-the-docs/issues/1607

‎_includes/package_table.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h3 id="{{cat.name}}">{{cat.title}}:</h3>
1515
<a href="{{project.url}}" class="logo">
1616
<img
1717
style="{{ project.projlogo-style | default: 'height:48px;'}}"
18-
src="{{site.baseurl}}{{ project.projlogo | link }}"
18+
src="{{ project.projlogo | relative_url }}"
1919
alt="{{project.name}} logo"
2020
/>
2121
</a>

‎index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ nav_order: 1
88

99
The Scikit-HEP project is a community-driven and community-oriented project
1010
with the aim of providing Particle Physics at large with an ecosystem for data
11-
analysis in Python. [Read more →]({{site.baseurl}}{% link pages/about/index.md %})
11+
analysis in Python. [Read more →]({% link pages/about/index.md %})
1212

1313
New users can start with our
14-
[user pages]({{site.baseurl}}{% link pages/user/index.md %}). See our
15-
[developer pages]({{site.baseurl}}{% link pages/developers/index.md %})
14+
[user pages]({% link pages/user/index.md %}). See our
15+
[developer pages]({% link pages/developers/index.md %})
1616
for information on developing Python packages.
1717

1818
<div markdown="1" class="text-center text-delta fs-3">
19-
[News]({{site.baseurl}}{% link pages/news.md %}) •
19+
[News]({% link pages/news.md %}) •
2020
[Tutorial](https://hsf-training.github.io/hsf-training-scikit-hep-webpage/) •
21-
[Resources]({{site.baseurl}}{% link pages/user/resources.md %}) •
22-
[Cite us]({{site.baseurl}}{% link pages/about/citing.md %}) •
23-
[Get in touch]({{site.baseurl}}{% link pages/user/getting-in-touch.md %})
21+
[Resources]({% link pages/user/resources.md %}) •
22+
[Cite us]({% link pages/about/citing.md %}) •
23+
[Get in touch]({% link pages/user/getting-in-touch.md %})
2424
</div>
2525

2626
{% include package_table.html %}
@@ -34,4 +34,4 @@ stack. If you are looking for a deprecated package, see the [full package list][
3434
[gitter-skhep-link]: https://gitter.im/Scikit-HEP/community
3535
[gitter-skhep-badge]: https://badges.gitter.im/Scikit-HEP/community.svg
3636

37-
[full package list]: {{site.baseurl}}{% link pages/packages/index.md %}
37+
[full package list]: {% link pages/packages/index.md %}

‎pages/about/citing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Citing Scikit-HEP
4-
permalink: /citing
4+
permalink: /citing/
55
nav_order: 1
66
parent: About
77
custom_title: Citing Scikit-HEP or individual packages

‎pages/about/code-of-conduct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Code of conduct
4-
permalink: /code-of-conduct
4+
permalink: /code-of-conduct/
55
nav_order: 1
66
parent: About
77
custom_title: Contributor covenant code of conduct

‎pages/about/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: FAQ
4-
permalink: /faq
4+
permalink: /faq/
55
nav_order: 4
66
parent: About
77
---

‎pages/about/funding.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Funding
4-
permalink: /funding
4+
permalink: /funding/
55
nav_order: 9
66
parent: About
77
---
@@ -34,9 +34,9 @@ provide funding for Eduardo Rodrigues (2020-) to work on this project part-time.
3434
[oac-1450377]: https://nsf.gov/awardsearch/showAward?AWD_ID=1450377
3535
[oac-1836650]: https://nsf.gov/awardsearch/showAward?AWD_ID=1836650
3636

37-
[img-nsf]: {{ site.baseurl }}{% link /assets/images/funding/nsf-logo-128.png %}
37+
[img-nsf]: {% link /assets/images/funding/nsf-logo-128.png %}
3838
{: width="70px"}
39-
[img-stfc]: {{ site.baseurl }}{% link /assets/images/funding/UKRI_STF_Council-Logo_Horiz-RGB.png %}
39+
[img-stfc]: {% link /assets/images/funding/UKRI_STF_Council-Logo_Horiz-RGB.png %}
4040
{: width="140px"}
41-
[img-liverpool]: {{ site.baseurl }}{% link /assets/images/funding/university-liverpool-logo.png %}
41+
[img-liverpool]: {% link /assets/images/funding/university-liverpool-logo.png %}
4242
{: width="140px"}

‎pages/about/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
layout: page
33
title: About
4-
permalink: /about
4+
permalink: /about/
55
nav_order: 90
66
has_children: true
77
---
88

99
The Scikit-HEP project
10-
(HEP stands for High Energy Physics, see more in the [FAQ]({{site.baseurl}}{% link pages/about/faq.md %} ))
10+
(HEP stands for High Energy Physics, see more in the [FAQ]({% link pages/about/faq.md %} ))
1111
is a community-driven and
1212
community-oriented project with the aim of providing Particle Physics at
1313
large with an ecosystem for data analysis in Python. The project started

‎pages/developers/badges.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Badges
4-
permalink: /badges
4+
permalink: /badges/
55
nav_order: 1
66
parent: Developer information
77
---

‎pages/developers/coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Code coverage 🔗
3-
permalink: /developer/coverage
3+
permalink: /developer/coverage/
44
nav_order: 3
55
parent: Developer information
66
redirect_to: https://learn.scientific-python.org/development/guides/coverage/

‎pages/developers/gha_basic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "GHA: Intro 🔗"
4-
permalink: /developer/gha_basic
4+
permalink: /developer/gha_basic/
55
nav_order: 10
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/gha-basic/

‎pages/developers/gha_pure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "GHA: Simple wheels 🔗"
4-
permalink: /developer/gha_pure
4+
permalink: /developer/gha_pure/
55
nav_order: 11
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/gha-pure/

‎pages/developers/gha_wheels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "GHA: Binary wheels 🔗"
4-
permalink: /developer/gha_wheels
4+
permalink: /developer/gha_wheels/
55
nav_order: 12
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/gha-wheels/

‎pages/developers/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Developer information
4-
permalink: /developer
4+
permalink: /developer/
55
nav_order: 30
66
has_children: true
77
---
@@ -55,8 +55,8 @@ simplify tasks and help new contributors.
5555
> your repository with the guidelines, runnable right in the guide via
5656
> WebAssembly! All checks point to a linked badge in the guide.
5757
58-
[guidelines]: {{ site.baseurl }}{% link pages/packages/guidelines.md %}
59-
[badges]: {{ site.baseurl }}{% link pages/developers/badges.md %}
58+
[guidelines]: {% link pages/packages/guidelines.md %}
59+
[badges]: {% link pages/developers/badges.md %}
6060
[intro]: https://learn.scientific-python.org/development/tutorials/dev-environment/
6161
[style]: https://learn.scientific-python.org/development/guides/style/
6262
[coverage]: https://learn.scientific-python.org/development/guides/coverage/

‎pages/developers/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Intro to development 🔗
3-
permalink: /developer/intro
3+
permalink: /developer/intro/
44
nav_order: 2
55
parent: Developer information
66
redirect_to: https://learn.scientific-python.org/development/tutorials/dev-environment/

‎pages/developers/mypy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Static type checking 🔗
4-
permalink: /developer/mypy
4+
permalink: /developer/mypy/
55
nav_order: 7
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/mypy/

‎pages/developers/nox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Task runners 🔗
4-
permalink: /developer/tasks
4+
permalink: /developer/tasks/
55
nav_order: 30
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/tasks/

‎pages/developers/packaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Packaging 🔗
4-
permalink: /developer/packaging
4+
permalink: /developer/packaging/
55
nav_order: 5
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/packaging-classic/

‎pages/developers/pep621.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Simple Python packaging 🔗
4-
permalink: /developer/pep621
4+
permalink: /developer/pep621/
55
nav_order: 4
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/packaging-simple/

‎pages/developers/pytest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Testing with pytest 🔗
4-
permalink: /developer/pytest
4+
permalink: /developer/pytest/
55
nav_order: 3
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/pytest/

‎pages/developers/repo_review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Repo Review 🔗
4-
permalink: /developer/reporeview
4+
permalink: /developer/reporeview/
55
nav_order: 110
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/repo-review/

‎pages/developers/style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Style 🔗
4-
permalink: /developer/style
4+
permalink: /developer/style/
55
nav_order: 6
66
parent: Developer information
77
redirect_to: https://learn.scientific-python.org/development/guides/style/

‎pages/news.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Project news
4-
permalink: /news
4+
permalink: /news/
55
nav_order: 2
66
---
77

‎pages/packages/affiliated.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Affiliated packages
4-
permalink: /affiliated
4+
permalink: /affiliated/
55
nav_order: 1
66
parent: Packages
77
title: Affiliated projects and packages
@@ -19,7 +19,7 @@ In the following, projects that work closely together with Scikit-HEP are descri
1919

2020
---
2121

22-
[![{{project.name}} logo]({{site.baseurl}}{{ project.image | link }}){: style="{{ project.image-style | default: "height:64px;"}}"}]({{project.url}}){: .largelogo }
22+
[![{{project.name}} logo]({{ project.image | relative_url }}){: style="{{ project.image-style | default: "height:64px;"}}"}]({{project.url}}){: .largelogo }
2323
{%- else -%}
2424

2525
---

0 commit comments

Comments
 (0)