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

Remove old and unsupported sphinx GHA #913

Merged
merged 4 commits into from
Aug 30, 2023
Merged

Conversation

ocefpaf
Copy link
Contributor

@ocefpaf ocefpaf commented Aug 29, 2023

Nothing to see here (yet). Just testing if we can fix the docs build and/or update the sphinx build here.

This one is ready for review.

@ocefpaf ocefpaf force-pushed the bump branch 2 times, most recently from cab7606 to 07762a8 Compare August 29, 2023 17:37
@ocefpaf ocefpaf marked this pull request as ready for review August 29, 2023 17:37
@ocefpaf
Copy link
Contributor Author

ocefpaf commented Aug 29, 2023

@paigem this improves a bit the doc situation here by:

  • removing the stale ammaraskar/sphinx-action GHA that relies on an outdated Dockefile with old sphinx
  • add dependabot for the GHA only, to keep them updated
  • install and builds sphinx via the Python GHA + requirements.txt file (easier to maintain, edit, and debug)
  • adds taminomara/sphinx-problem-matcher GHA to keep the sphinx inline comments (untested)
  • removes app.connect("source-read", rstjinja) that prevent sphinx from running.

That last step is odd b/c the current approach doesn't error out on it but I could not get an error free build with rstjinja. I'm not sure that is actually used so we need input from the folks that implemented that to be sure we can remove it. It was added in #293

Or, maybe there is just a malformed jinja somewhere and rstjinja is working as expected, not sure.

TL;DR this is not ready for merging 😬

@ocefpaf
Copy link
Contributor Author

ocefpaf commented Aug 29, 2023

OK, the problem was not rstjinja but a double documented file, the hpc.md and hpc.rst. I removed the md version and, if that is OK, this PR is ready for review.

@ocefpaf ocefpaf changed the title test if we can just bump sphinx Remove old and unsupported sphinx GHA Aug 29, 2023
@TomAugspurger
Copy link
Member

Thanks @ocefpaf! It does look like sphinx-problem-matcher is working: https://github.com/pangeo-data/pangeo/pull/913/files#diff-9956fdac1df3f4fd0af96bed18d51583a4ab55b933b4efb6a91999f4fb4698a9 (nothing too serious, so we can fix those later).

@TomAugspurger TomAugspurger merged commit 9a6b528 into pangeo-data:master Aug 30, 2023
@ocefpaf ocefpaf deleted the bump branch August 30, 2023 12:49
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