Skip to content

Upgrade docsy to 0.12.0 #2160

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Upgrade docsy to 0.12.0 #2160

wants to merge 3 commits into from

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented Jun 9, 2025

Based on matrix-org/docsy#6.

The main reason for the changes here is to adapt to the new template system introduced in Hugo 0.146.0.

In layouts, we:

  • remove _default and move everything in it directly under layouts
  • rename partials and shortcodes to _partials and _shortcodes
  • adapt to Hugo and docsy changes about the render-heading hook. We don't need a copy of the heading self-link template now that it is defined as a partial.
  • update docs/baseof.html to match a change upstream
  • split docs/changelog.html because it isn't used for the section page anymore. We create a changelog-index layout for this.

Nothing stood out to me as a change in the rendered spec.

Closes #2084.

Pull Request Checklist

Preview: https://pr2160--matrix-spec-previews.netlify.app

zecakeh added 3 commits June 9, 2025 10:44
Docsy 0.12.0 requires at least Hugo 0.146.0 because of changes to
template paths.

Signed-off-by: Kévin Commaille <[email protected]>
A big change for template paths landed in Hugo 0.146.0.

In `layouts`, we:

- remove `_default` and move everything in it directly under `layouts`
- rename `partials` and `shortcodes` to `_partials` and `_shortcodes`
- adapt to Hugo and docsy changes about the render-heading hook.
  We don't need a copy of the heading self-link template now that it is
  defined as a partial.
- update `docs/baseof.html` to match a change upstream
- split `docs/changelog.html` because it doesn't work for the section
  page anymore. We create a `changelog-index` layout for this.

Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
@zecakeh zecakeh marked this pull request as ready for review June 27, 2025 19:06
@zecakeh zecakeh requested a review from a team as a code owner June 27, 2025 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Spec documentation doesn't build with Hugo 0.141+
1 participant