-
Notifications
You must be signed in to change notification settings - Fork 253
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
Fix some doc warnings and convert to myst #482
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #482 +/- ##
=======================================
Coverage 82.32% 82.32%
=======================================
Files 76 76
Lines 10315 10315
=======================================
Hits 8492 8492
Misses 1823 1823
|
More detailed checks picked up a number of issues in the docs with some (especially \begin{equation}\tag{1}
...
\end{equation} and \begin{align}
\end{align} are not showing up properly in html. These issues seem to all be fixed in |
Update: After offline discussion, we have decided to go ahead and merge this in before sphinx 4.3.0 is released. This will break the Since this PR will now be merged in, I have opened an issue (#505) as a reminder to update. |
This PR converts the
alibi
docs to usemyst
files instead ofrst
(for consistency withalibi-detect
SeldonIO/alibi-detect#325).This allows for the now deprecated
m2r
to be removed, and the use of newersphinx
versions going forwards.TODO:
Bases
in api docs.xgboost_model_fitting_adult.ipynb
in examples, or add orphan tag. - Orphan tag added.Relevant issues: