-
-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add CI test for sphinx-intl's doc #107
Conversation
Allows to call manually the workflow, which is helpful for linkcheck
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check my comment. I think there is a problem.
Needed due to a import of sphinx-intl in doc/conf.py
Dependency issue fixed. Check is failing as expected: there are issues in the doc. I remembered now to add problem-matcher actions that annotate the issues in GitHub Actions web interface. sphinx-doc/github-problem-matcher is for building docs with sphinx-build and rffontenelle/sphinx-lint-problem-matcher is for sphinx-lint. linkcheck builder doesn't have a appropriate output for matching, so it won't be annotated. If you prefer, the problem-matcher json files can be added to this repository and enabled/disabled instead of relying on external actions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your thorough explanation. I appreciate your work on fixing the dependency issue and adding GitHub Actions annotations.
Regarding the problem-matcher JSON files, I think we should keep them as external dependencies to maintain simplicity.
We'll address the documentation issues post-merge.
Thank you again for your valuable work.
I'll check the operation a little later on hand and merge it in. |
I ran the workflow locally, and the lint errors etc. were displayed as expected. For the record, the results of running GHA in act are posted here.
|
Running these commands locally, it reported broken anchors and broken external links in the documentation. So, having these allows to make sure the docs is all good.
P.s.: Waiting for #106 to add CHANGES entry