Skip to content

Conversation

@rgaiacs
Copy link
Contributor

@rgaiacs rgaiacs commented Oct 8, 2025

This is related to #825.

It moves the docs/_data/contributors/gen_contributors.py into docs/_ext/contributors.py and adapts the code to Sphinx extension.

As a Sphinx extension, we can write our own HTML.

@rgaiacs rgaiacs self-assigned this Oct 8, 2025
@rgaiacs rgaiacs marked this pull request as draft October 8, 2025 10:27
@minrk
Copy link
Member

minrk commented Oct 9, 2025

Nice!

@rgaiacs rgaiacs force-pushed the 825-sphinx-extension branch from 22b69cd to c69c6d3 Compare October 21, 2025 15:35
@rgaiacs rgaiacs changed the title [draft] [do not merge] Replace Python script with Sphinx extension Replace Python script with Sphinx extension Oct 21, 2025
@rgaiacs rgaiacs marked this pull request as ready for review October 21, 2025 15:35
@rgaiacs rgaiacs requested a review from minrk October 21, 2025 15:35
@rgaiacs
Copy link
Contributor Author

rgaiacs commented Oct 21, 2025

This pull request can be preview at https://jupyterhub-team-compass--826.org.readthedocs.build/team/.

Before After
image image

I did my best to keep all existing features. Instead of use a script to write a file with the list of cards, the list of cards is built in memory. This should have little difference in the render time as the creation of files were always triggered. This will solve the problem with sphinx-autobuild given that no file in the source will change when creating the list of cards.

There are a little bit of duplication in the HTML across the .py files. I don't think that extra code refactoring worth to avoid the HTML code duplication.

I didn't check but I think that we don't use sphinx-design any more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants