Skip to content

Move from Python to Twig - #3014

Merged
adriendupuis merged 8 commits into
optimize-php-api-reffrom
optimize-php-api-ref-ad
Jan 19, 2026
Merged

adriendupuis merged 8 commits into
optimize-php-api-reffrom
optimize-php-api-ref-ad

Conversation

@adriendupuis

@adriendupuis adriendupuis commented Jan 16, 2026 •

Copy link
Copy Markdown
Contributor
Question Answer
JIRA Ticket N/A
Versions 5.0, 4.6
Edition All

Use index.html as the reference to get the navigation sidebar from (instead of having an external file to store it and a Python script to extract it).
Use sidebar.html.twig template to have the JS in every pages but index.html and reports/*.html (so no Python script needed to make the replacement).

I fixed an issue with the highlight of the current nav menu item.

Some previews (browse in private mode to not have too much cache):

Main changes compare to 5.0 branch are in tools/api_refs/.phpdoc/template/components:

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

Comment thread tools/api_refs/.phpdoc/template/components/sidebar.html.twig Outdated
@github-actions

Copy link
Copy Markdown

Preview of modified files: no change to preview.

@adriendupuis
adriendupuis marked this pull request as ready for review January 19, 2026 08:16
@adriendupuis
adriendupuis requested a review from mnocon January 19, 2026 08:16

@mnocon mnocon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, it's great 🎉

@adriendupuis
adriendupuis merged commit eada870 into optimize-php-api-ref Jan 19, 2026
6 of 7 checks passed
@adriendupuis
adriendupuis deleted the optimize-php-api-ref-ad branch January 19, 2026 09:37
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.

2 participants