-
Notifications
You must be signed in to change notification settings - Fork 22
updates vitepress config #1135
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
updates vitepress config #1135
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1135 +/- ##
===========================================
+ Coverage 21.66% 42.85% +21.18%
===========================================
Files 46 110 +64
Lines 8048 19436 +11388
===========================================
+ Hits 1744 8329 +6585
- Misses 6304 11107 +4803 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
docs/src/.vitepress/config.mts
Outdated
|
||
ignoreDeadLinks: true, // tested in Documenter.jl directly | ||
|
||
ignoreDeadLinks: false, // tested in Documenter.jl directly |
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.
the dead links are coming from the auto-generated MLIR Dialects files, lets ignore them for the time being
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.
too late 😢, I almost finish the update.
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.
done! from my side, things should work now.
Please, if comments for small details, please commit/suggest here directly 😄 .
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.
Unfortunately, any changes to the Dialects directory will be overwritten by the automatic CI 😢. The links come from upstream packages which we have limited control over
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.
that doesn't sound ideal. But, surely(?) that automatic step doesn't happened every time, we should be able to fix this, specially the links, otherwise this will be broken always.
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.
it does, every 24 hr the CI runs, fetches code from upstream (we live on the master branch of pretty much all upstream repositories so updates are very frequent), and if there is a diff overwrites the version on main.
We could try to write an automatic mapping from auto-generated links to the correct link, but that sounds like a lot of effort and needs to be done separately for each dialect
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.
uff, ok, got it! setting ignore deadinks to true
for when things get overwritten and dead links are back. Otherwise, things should work.
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.
yeah its about to be auto overwritten here: #1139
coming from
run: julia --project=. --color=yes make-bindings.jl |
from
build_file(joinpath(src_dir, "mlir", "Dialects", file)) |
autogenerated via https://github.com/EnzymeAD/Reactant.jl/blob/2ba8da2991f5ddaa7aa03514b1cd47134b2b3b1d/deps/ReactantExtra/tblgen/jl-generators.cc
if you want to help add support for the actual url that would be amazing!
this PR only deals with updating the docs pages.
npm
package.json list packagesmake.jl
sincepages
is actually being done at theconfig.mts
level.