Skip to content

ci: fixing baseurl #395

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.

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

Merged
merged 4 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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-)
10 changes: 9 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
27 changes: 17 additions & 10 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
11 changes: 6 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/just-the-docs@v0.5.3"
theme: "just-the-docs"
plugins:
- jekyll-feed

Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion _includes/package_table.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
16 changes: 8 additions & 8 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand All @@ -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 %}
2 changes: 1 addition & 1 deletion pages/about/citing.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion pages/about/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion pages/about/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: FAQ
permalink: /faq
permalink: /faq/
nav_order: 4
parent: About
---
Expand Down
8 changes: 4 additions & 4 deletions pages/about/funding.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Funding
permalink: /funding
permalink: /funding/
nav_order: 9
parent: About
---
Expand Down Expand Up @@ -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"}
4 changes: 2 additions & 2 deletions pages/about/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
layout: page
title: About
permalink: /about
permalink: /about/
nav_order: 90
has_children: true
---

The Scikit-HEP project
(HEP stands for High Energy Physics, see more in the [FAQ]({{site.baseurl}}{% link pages/about/faq.md %} ))
(HEP stands for High Energy Physics, see more in the [FAQ]({% link pages/about/faq.md %} ))
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. The project started
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/badges.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Badges
permalink: /badges
permalink: /badges/
nav_order: 1
parent: Developer information
---
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/coverage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Code coverage 🔗
permalink: /developer/coverage
permalink: /developer/coverage/
nav_order: 3
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/coverage/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/gha_basic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "GHA: Intro 🔗"
permalink: /developer/gha_basic
permalink: /developer/gha_basic/
nav_order: 10
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/gha-basic/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/gha_pure.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "GHA: Simple wheels 🔗"
permalink: /developer/gha_pure
permalink: /developer/gha_pure/
nav_order: 11
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/gha-pure/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/gha_wheels.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "GHA: Binary wheels 🔗"
permalink: /developer/gha_wheels
permalink: /developer/gha_wheels/
nav_order: 12
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/gha-wheels/
Expand Down
6 changes: 3 additions & 3 deletions pages/developers/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Developer information
permalink: /developer
permalink: /developer/
nav_order: 30
has_children: true
---
Expand Down Expand Up @@ -55,8 +55,8 @@ simplify tasks and help new contributors.
> your repository with the guidelines, runnable right in the guide via
> WebAssembly! All checks point to a linked badge in the guide.

[guidelines]: {{ site.baseurl }}{% link pages/packages/guidelines.md %}
[badges]: {{ site.baseurl }}{% link pages/developers/badges.md %}
[guidelines]: {% link pages/packages/guidelines.md %}
[badges]: {% link pages/developers/badges.md %}
[intro]: https://learn.scientific-python.org/development/tutorials/dev-environment/
[style]: https://learn.scientific-python.org/development/guides/style/
[coverage]: https://learn.scientific-python.org/development/guides/coverage/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Intro to development 🔗
permalink: /developer/intro
permalink: /developer/intro/
nav_order: 2
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/tutorials/dev-environment/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/mypy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Static type checking 🔗
permalink: /developer/mypy
permalink: /developer/mypy/
nav_order: 7
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/mypy/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/nox.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Task runners 🔗
permalink: /developer/tasks
permalink: /developer/tasks/
nav_order: 30
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/tasks/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/packaging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Packaging 🔗
permalink: /developer/packaging
permalink: /developer/packaging/
nav_order: 5
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/packaging-classic/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/pep621.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Simple Python packaging 🔗
permalink: /developer/pep621
permalink: /developer/pep621/
nav_order: 4
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/packaging-simple/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/pytest.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Testing with pytest 🔗
permalink: /developer/pytest
permalink: /developer/pytest/
nav_order: 3
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/pytest/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/repo_review.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Repo Review 🔗
permalink: /developer/reporeview
permalink: /developer/reporeview/
nav_order: 110
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/repo-review/
Expand Down
2 changes: 1 addition & 1 deletion pages/developers/style.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Style 🔗
permalink: /developer/style
permalink: /developer/style/
nav_order: 6
parent: Developer information
redirect_to: https://learn.scientific-python.org/development/guides/style/
Expand Down
2 changes: 1 addition & 1 deletion pages/news.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Project news
permalink: /news
permalink: /news/
nav_order: 2
---

Expand Down
4 changes: 2 additions & 2 deletions pages/packages/affiliated.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Affiliated packages
permalink: /affiliated
permalink: /affiliated/
nav_order: 1
parent: Packages
title: Affiliated projects and packages
Expand All @@ -19,7 +19,7 @@ In the following, projects that work closely together with Scikit-HEP are descri

---

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

---
Expand Down
Loading