modified conf.py as per scikit-learn guidelines on adding examples to… #1359
Conversation
This file contains 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
adrinjalali
reviewed
Apr 26, 2024
Comment on lines
+176
to
+177
| "doc_module" : ('fairlearn.fairlearn.datasets', 'fairlearn.fairlearn.metrics', 'fairlearn.fairlearn.postprocessing', 'fairlearn.fairlearn.preprocessing', 'fairlearn.fairlearn.reductions', 'fairlearn.fairlearn.adversarial', 'fairlearn.fairlearn.experimental'), | ||
| "backreferences_dir" : "backref_dir", |
There was a problem hiding this comment.
this is what we have in sklearn though:
"doc_module": "sklearn",
"backreferences_dir": os.path.join("modules", "generated"),There was a problem hiding this comment.
the doc_module is supposed to contain the names of the modules for which documentation should be rebuilt. I gave those values to follow the folder structure for the project. I tried with "fairlearn.module_name" and just "fairlearn" but with no results.
The backreferences_dir is supposed to be a place where the generated gallery would be stored. So it has to be initially empty. The value entered in scikit-learn (modules/generated) doesn't already exist in their project - only the "modules" folder exists. So I believe "generated" gets created when the documentation is rebuilt, although I'm not 100% sure about that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
… API docs
Description
Tests
Documentation
Screenshots