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

Docs: Build with Sphinx --pre release #1130

Closed
wants to merge 3 commits into from
Closed

Conversation

humitos
Copy link
Member

@humitos humitos commented Apr 14, 2021

If a Requirement specifier includes a pre-release or development
version (e.g. >=0.0.dev0) then pip will allow pre-release and development
versions for that requirement. This does not include the != flag.

From https://pip.pypa.io/en/latest/cli/pip_install/#pre-release-versions

Do not merge this PR, it's just a test to build the theme with Sphinx --pre release

Edit: I did this as an example for sphinx-doc/sphinx#9088 (comment)

    If a Requirement specifier includes a pre-release or development
    version (e.g. >=0.0.dev0) then pip will allow pre-release and development
    versions for that requirement. This does not include the != flag.

From pip.pypa.io/en/latest/cli/pip_install/#pre-release-versions
@humitos humitos added the Status: blocked Issue is blocked on another issue label Apr 14, 2021
@Blendify
Copy link
Member

I guess this should be used with #1123?

@Blendify Blendify changed the title Build with Sphinx --pre release Docs: Build with Sphinx --pre release Apr 14, 2021
@humitos
Copy link
Member Author

humitos commented Apr 19, 2021

@Blendify I added this as an example of sphinx-doc/sphinx#9088 (comment)

I don't think we want to add this to master for building our docs. However, it may be a good idea to add it to the Sphinx versions that are used to test our theme so we can find issues on our theme before the release is done.

@humitos
Copy link
Member Author

humitos commented Apr 26, 2021

@ericholscher One failure that I found is that this page breaks: https://sphinx-rtd-theme--1130.org.readthedocs.build/en/1130/demo/demo.html. The table of content does not render properly.

See the original: https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html

It seems the CSS selector is too specific based on .section class that it was replaced by a <section> html tag in docutils==0.17

@Blendify
Copy link
Member

Can this be closed now?

@humitos
Copy link
Member Author

humitos commented Jun 14, 2021

Yes. Let's close it. It was a test for the pre-release of Sphinx.

However, we should probably create an automated way of building our theme with the latest pre-release of Sphinx to detect breaking changes earlier.

@humitos humitos closed this Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: blocked Issue is blocked on another issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants