Skip to content
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

Use stable Sphinx for building the "default" images #114

Closed
humitos opened this issue Oct 20, 2022 · 3 comments
Closed

Use stable Sphinx for building the "default" images #114

humitos opened this issue Oct 20, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@humitos
Copy link

humitos commented Oct 20, 2022

Hi! I'm opening this issue because of this comment from @pradyunsg

@humitos Those are themes being broken with Sphinx 6 (part of the goal with this site was to have it automatically test Sphinx pre-releases across themes). It's mildly concerning that alabaster is failing with Sphinx 6. :)

(from #113 (comment))

I think it's really good to build all the themes with the latest beta release from Sphinx because it helps developers to know if their theme is going to work once that version of Sphinx becomes stable. However, from a Sphinx's user perspective, it's not good to be pointed to this site to decide which theme to use and realize that some of them are broken.

Besides, from a marketing perspective, it's not good for the Sphinx ecosystem in general, to refer to this site as the canonical place to find really good themes and decide which one to use, but find there are some that are broken.

That said, I think it would be awesome if we could have two different versions of this site:

  • public facing using the latest stable release for Sphinx
  • developer facing using the latest beta release for Sphinx

I went ahead and tried this using Read the Docs:

I'm happy to rebase the commits and create a PR if you consider this work useful. If you like this work, but want to keep using GH pages to host the both versions, we can figure it out how to do it there as well. Let me know.

@pradyunsg
Copy link
Collaborator

I'm fine with making a split on this site -- I'd still prefer to have a single landing page though for this; and have different Sphinx versions be presented under a dropdown or something. :)

@pradyunsg pradyunsg added the enhancement New feature or request label Oct 20, 2022
@pradyunsg pradyunsg changed the title Build site with latest stable and beta Sphinx versions Use stable Sphinx for building the "default" images, with a separate view for the latest Sphinx pre-release Oct 20, 2022
@pradyunsg pradyunsg changed the title Use stable Sphinx for building the "default" images, with a separate view for the latest Sphinx pre-release Use stable Sphinx for building the "default" images Oct 20, 2022
@pradyunsg
Copy link
Collaborator

Besides, from a marketing perspective, it's not good for the Sphinx ecosystem in general, to refer to this site as the canonical place to find really good themes and decide which one to use, but find there are some that are broken.

Agreed. With #115, I've switched to using the stable Sphinx release for themes.

That said, I think it would be awesome if we could have two different versions of this site:

* public facing using the latest _stable_ release for Sphinx
* developer facing using the latest _beta_ release for Sphinx

Let's track this separately. I've opened #116 for this.

@humitos
Copy link
Author

humitos commented Oct 20, 2022

I'd still prefer to have a single landing page though for this; and have different Sphinx versions be presented under a dropdown or something. :)

I'd love to see this 😍 . I like the idea 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants