modified conf.py as per scikit-learn guidelines on adding examples to… #1359
Conversation
| "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.
There was a problem hiding this comment.
I think the right way to specify the doc module is just to specify "fairlearn". I tried building the docs using this conf.py file, and it looks like in the backref_dir, the thumbnails are being generated (see the image below), but they aren't showing up on the API pages. I wonder if that's because of the way that the API reference is now structured (i.e., using autodoc).
|
Sorry, I've been remiss about this.... can you explain what problem this is trying to solve? I'm not being enlightened by the PR description. |
The goal was to have relevant example notebooks show up at bottom of the respective APIs - like it currently happens in scikit-learn. @alliesaizan do let me know if there anything that I can look into regarding this issue. If nothing can be done from my end, do unassign me. Thank you |
… API docs
Description
Tests
Documentation
Screenshots