Repository navigation
Docs: build from uv.lock in CI and on Read the Docs, move to Sphinx 9 and pydata-sphinx-theme #809
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
Merged
milton-minervino
merged 12 commits into
MAIF:develop
from
milton-minervino:feature/docs-ci
Oct 29, 2026
Merged
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b73853a
build(docs): build the docs from uv.lock in CI and on Read the Docs
milton-minervino 86e358d
docs: move to Sphinx 9, pydata-sphinx-theme and myst-nb
milton-minervino 13e4d19
docs: fix reST errors in docstrings
milton-minervino 9b9db24
docs: rewrite the home, getting started and installation pages
milton-minervino a618303
docs: document the report customization and standalone plot APIs
milton-minervino 5391f99
docs: fix "dictionary" misspellings in docstrings, messages and tutor…
milton-minervino 1ab35de
docs: link plotly types and allow building the docs offline
milton-minervino 9e0c6d9
docs: align the navbar left and add a dark-mode logo
milton-minervino 23eace2
docs: strip prompts when copying code and hide the page source link
milton-minervino faf0ae6
Merge branch 'develop' into feature/docs-ci
milton-minervino 591d180
Merge remote-tracking branch 'upstream/develop' into feature/docs-ci
milton-minervino 0972aad
docs: add a version switcher to the header
milton-minervino File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| /* Let wide code blocks in docstring parameter lists scroll instead of widening the whole list */ | ||
| dl.field-list > dd { | ||
| min-width: 0; | ||
| } | ||
|
|
||
| /* Center the links next to the logo in the company table of the home page */ | ||
| table.company-table td { | ||
| vertical-align: middle; | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,69 @@ | ||
| .. index: | ||
|
|
||
| Documentation | ||
| API reference | ||
| ============= | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| The public API of Shapash. Each entry links to its full documentation. | ||
|
|
||
| Tabular data | ||
| ------------ | ||
|
|
||
| .. currentmodule:: shapash | ||
|
|
||
| .. autosummary:: | ||
|
|
||
| explainer.smart_explainer.SmartExplainer | ||
| explainer.smart_plotter.SmartPlotter | ||
| explainer.consistency.Consistency | ||
| explainer.smart_predictor.SmartPredictor | ||
| utils.load_smartpredictor.load_smartpredictor | ||
| data.data_loader.data_loading | ||
|
|
||
| Report and standalone plots | ||
| --------------------------- | ||
|
|
||
| shapash.explainer.rst | ||
| shapash.predictor.rst | ||
| shapash.load_smartpredictor.rst | ||
| shapash.data.rst | ||
| .. autosummary:: | ||
|
|
||
| report.ReportTemplate | ||
| report.export_report_yml | ||
| report.blocks.ReportBlockMixin | ||
| report.blocks.block | ||
| plots.plot_univariate.plot_distribution | ||
| plots.plot_correlations.plot_correlations | ||
| plots.plot_evaluation_metrics.plot_confusion_matrix | ||
| plots.plot_feature_importance.plot_feature_importance | ||
|
|
||
| Backends | ||
| -------- | ||
|
|
||
| .. autosummary:: | ||
|
|
||
| backend.BaseBackend | ||
| backend.ShapBackend | ||
| backend.LimeBackend | ||
|
|
||
| Text data (NLP) | ||
| --------------- | ||
|
|
||
| .. autosummary:: | ||
|
|
||
| explainer.nlp_explainer.NlpExplainer | ||
| explainer.nlp_explanation.NlpExplanation | ||
| explainer.nlp_plotter.NlpPlotter | ||
| webapp.nlp_app.NlpWebApp | ||
| model.HFClassifierModel | ||
| model.HFPipelineModel | ||
| backend.NlpShapBackend | ||
| backend.NlpLimeBackend | ||
| backend.NlpCaptumLigBackend | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :hidden: | ||
|
|
||
| License is Apache Software License 2.0 | ||
| shapash.explainer | ||
| shapash.predictor | ||
| shapash.load_smartpredictor | ||
| shapash.data | ||
| shapash.report | ||
| shapash.plots | ||
| shapash.backend | ||
| shapash.nlp |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| Backends | ||
| ======== | ||
|
|
||
| A backend computes the contributions that Shapash displays. Pass one to ``SmartExplainer`` with the | ||
| ``backend`` argument, as a name (``"shap"``, ``"lime"``) or an instance. Subclass ``BaseBackend`` to | ||
| write your own. | ||
|
|
||
| .. autoclass:: shapash.backend.BaseBackend | ||
|
|
||
| .. autoclass:: shapash.backend.ShapBackend | ||
|
|
||
| .. autoclass:: shapash.backend.LimeBackend |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 purpose of this file was to change version of shapash documentation, is there a new way of doing it with the last version of sphynx ?
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.
Good catch. That template only worked with sphinx_material: it replaced the theme's whole sidebar and used its CSS classes and templates. Since we switched to a new theme, it went away.
Version switching should still works through the Read the Docs switch dropdown menu. I could not check it yet since it must be first merged into
develop. It's enabled on the project and is added to every build whatever the theme, so the new docs keep it.If we want a selector back in the page itself, the simplest way is to reuse the old script as a
pydata-sphinx-themeheader dropdown. It would read the same Read the Docs version data, so there's nothing to maintain. pydata's built-in switcher also works, but it needs aswitcher.jsonupdated at each release. I'd add the dropdown in a follow-up once a second version uses the new theme, or in this PR if you'd rather have it now.