Skip to content

Update GitHub Actions testing workflow #94

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

Merged
merged 2 commits into from
Jan 18, 2023
Merged

Conversation

AA-Turner
Copy link
Member

Updated remaining jQuery scripts to standard JavaScript, and a few fixes for CSS changes.

I marked various backwards compatability points explicitly -- I don't know what the supported Sphinx versions are for this theme.

A

@JulienPalard
Copy link
Member

This PR needs a review, it looks interesting. (Sadly my front-end skill don't allow me to understand it.)

@AA-Turner
Copy link
Member Author

@pradyunsg would you have time for a review? (I admit I entirely forgot I made this PR...)

A

@ezio-melotti ezio-melotti self-requested a review October 15, 2022 20:57
@AA-Turner
Copy link
Member Author

@JulienPalard can we build and publish a test version of CPython's docs with this PR? That might assuage your concerns over the JS.

A

@JulienPalard
Copy link
Member

JulienPalard commented Oct 27, 2022

@JulienPalard can we build and publish a test version of CPython's docs with this PR? That might assuage your concerns over the JS.

Yes but it will be overwritten by the daily build so I doubt it's a good idea. However a build is available in the "checks" tab as a build artifact, so we can test locally. It is done using the same script as in production so it should be similar.

But it builds a 3.9 with a Sphinx 2.4.4, which is probably not very interesting :D

I'll try to find the time to do a full build locally, I mean whith multiple Sphinx versions used by the different python versions, to see if there's any compatibility issue, it's easy to do using docsbuild-script and it's --theme argument, if you want to try it, an example invocation is provided in docsbuild's README.

@AA-Turner AA-Turner closed this Nov 11, 2022
@AA-Turner AA-Turner reopened this Nov 11, 2022
@AA-Turner AA-Turner changed the title Update for Sphinx 5 Update GitHub Actions testing workflow Nov 11, 2022
@AA-Turner
Copy link
Member Author

@JulienPalard inspired by a comment from Cam I have taken out all JS changes, which are only strictly necessary for Sphinx 6. python-docs-theme actually works as-is on Sphinx 5.0.1 and newer, so this PR now just updates tests.yml.

A

@ezio-melotti ezio-melotti requested a review from hugovk November 13, 2022 04:31
Comment on lines +25 to +35
run: >
python ./docsbuild-scripts/build_docs.py
--quick
--build-root ./build_root
--www-root ./www
--log-directory ./logs
--group $(id -g)
--skip-cache-invalidation
--theme $(pwd)
--language en
--branch 3.11
Copy link
Member

Choose a reason for hiding this comment

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

Much more readable! 👍

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

@hugovk hugovk mentioned this pull request Nov 19, 2022
10 tasks
@hugovk
Copy link
Member

hugovk commented Jan 18, 2023

Let's merge, this only updates the GitHub Actions workflow file and importantly allows testing feature branches (I want to test some changes before creating a PR), and has three approvals.

Thanks!

@hugovk hugovk merged commit 688f3ef into python:master Jan 18, 2023
@AA-Turner AA-Turner deleted the sphinx-5 branch April 11, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants