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.

Sign up for GitHub

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

Jump to bottom

ci: add documentation checks #3504

Merged
merged 18 commits into from
Oct 10, 2024
Merged

ci: add documentation checks #3504

merged 18 commits into from
Oct 10, 2024

Conversation

Saviq
Copy link
Collaborator

@Saviq Saviq commented Jul 23, 2024

No description provided.

@Saviq Saviq force-pushed the MIRENG-423-auto-doc-checks branch from eeade1c to 9d177e0 Compare July 29, 2024 07:38
@tarek-y-ismail
Copy link
Contributor

Looks like this has some issues with the Doxyfile inclusion thing we discussed before. It assumes that doc/sphinx will have a Doxyfile but in reality it's at <build dir>/doc/sphinx.

@Saviq
Copy link
Collaborator Author

Saviq commented Aug 7, 2024

It's worse, there isn't a Doxyfile at all, just a Doxyfile.in - I need to run cmake on it before.

Saviq
Saviq commented Oct 3, 2024
View reviewed changes
Copy link
Collaborator Author

@Saviq Saviq left a comment •
edited
Loading

Choose a reason for hiding this comment

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

For all these:

cd ../build_doc/doc/sphinx/

Couldn't we actually change the working-directory?

.github/workflows/automatic-doc-checks.yml Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
.github/workflows/automatic-doc-checks.yml Show resolved Hide resolved
@Saviq Saviq marked this pull request as ready for review October 7, 2024 07:22
@Saviq Saviq requested a review from a team as a code owner October 7, 2024 07:22
Saviq
Saviq commented Oct 7, 2024
View reviewed changes
Copy link
Collaborator Author

@Saviq Saviq left a comment

Choose a reason for hiding this comment

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

Like it how the custom wordlist shows us what can be easily improved.

Still uneasy about all the cd ${WORKSPHINX} bits… but I suppose we'd need to modify the upstream workflow to improve that (e.g. have a separate ${CONFIGDIR} that the configure, or, say ${PREPAREDIR}/prepare target would generate and then the individual checks targets would depend on that. If it happened to be equal (the default), it would be NOOP.

.github/workflows/automatic-doc-checks.yml Outdated Show resolved Hide resolved
.github/workflows/automatic-doc-checks.yml Outdated Show resolved Hide resolved
doc/sphinx/.sphinx/pa11y.json Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
Saviq
Saviq commented Oct 7, 2024
View reviewed changes
Copy link
Collaborator Author

@Saviq Saviq left a comment

Choose a reason for hiding this comment

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

One last thing inline.

doc/sphinx/Makefile Outdated Show resolved Hide resolved
@tarek-y-ismail
Install Mir dependencies
6fc2a5f
@tarek-y-ismail
Configure Mir so that HTML docs can be built
6e22ee2
@tarek-y-ismail
Make pa11y targets run in the build directory
05b441a 
No need to move to the `../build_doc` for `woke` since it only checks
`*.rst` files which are not the result of doc building.
@tarek-y-ismail
Don't rebuild docs (html) if already built
d64d803
@tarek-y-ismail
Skip all HTML files inside all api directories
46ada23
@tarek-y-ismail
Use pa11y-ci instead of pa11y
827294b
@tarek-y-ismail
Minor cleanup
d0095fc
@tarek-y-ismail
Filter out many HTML files from spellcheck and accessibility check.
969c116 
Also, updated custom wordlist
@tarek-y-ismail
Minor docs fixes.
d07608f 
Fix typo in `how-to-enable-graphics-core22-on-a-device.md` and change
`BkSp` to `Backspace` in `getting_involved_in_mir.md`
@tarek-y-ismail
Move _build/index.html to be a proper target, don't rebuild on CI
b9fb6c5
@tarek-y-ismail
Modify doc check workflow triggers
99f24ab
@Saviq
Copy link
Collaborator Author

Saviq commented Oct 9, 2024

Looks like we have just a few broken links to get this in a happy place? Most are "missing anchor", which should be ingored, but a couple seem legit issues.

Saviq
Saviq commented Oct 9, 2024
View reviewed changes
Copy link
Collaborator Author

@Saviq Saviq left a comment

Choose a reason for hiding this comment

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

Just some nitpicks.

.github/workflows/automatic-doc-checks.yml Outdated Show resolved Hide resolved
.github/workflows/automatic-doc-checks.yml Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
doc/sphinx/Makefile Outdated Show resolved Hide resolved
@tarek-y-ismail
Copy link
Contributor

Looks like we have just a few broken links to get this in a happy place? Most are "missing anchor", which should be ingored, but a couple seem legit issues.

I think fixing the issues that the checks exposed should be in a separate PR as this is bloated enough :)

@Saviq
Copy link
Collaborator Author

Saviq commented Oct 9, 2024

I think fixing the issues that the checks exposed should be in a separate PR as this is bloated enough :)

Fine :)

Saviq
Saviq commented Oct 9, 2024
View reviewed changes
Copy link
Collaborator Author

@Saviq Saviq left a comment

Choose a reason for hiding this comment

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

Last leftover and let's get it in :)

@Saviq Saviq enabled auto-merge October 9, 2024 11:50
tarek-y-ismail
tarek-y-ismail approved these changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@tarek-y-ismail tarek-y-ismail left a comment

Choose a reason for hiding this comment

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

image

@Saviq Saviq added this pull request to the merge queue Oct 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 9, 2024
@tarek-y-ismail tarek-y-ismail added this pull request to the merge queue Oct 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 9, 2024
@Saviq Saviq added this pull request to the merge queue Oct 10, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 10, 2024
@tarek-y-ismail tarek-y-ismail added this pull request to the merge queue Oct 10, 2024
Merged via the queue into main with commit c70833c Oct 10, 2024
37 of 38 checks passed
@tarek-y-ismail tarek-y-ismail deleted the MIRENG-423-auto-doc-checks branch October 10, 2024 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tarek-y-ismail tarek-y-ismail tarek-y-ismail approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Saviq @tarek-y-ismail