DOC - Fix most documentation build warnings #539
Merged
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
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.
Description
Fixing most warnings appearing when building the documentation (ie running
make doc). The goal was to start from a clean state when working on the v1 documentation. This PR may break a few things, but mostly it will guarantee an overall proper display of documentation and especially docstrings, IDE included.I didn't manage to fix all the warnings related to the file
mapie/conformity_scores/regression.py. It seems pretty broken: when I delete problematic docstrings, new warning appears, making me think something is kind of corrupting the docstring parsing at some point.Fixes #(issue)
Type of change
Please remove options that are irrelevant.
Checklist
make lintmake type-checkmake testsmake coveragemake doc