docs: Fix mkdocs DeprecationWarning #183
Merged
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.
Docs failed to build...
Locally we get more information (even though we are using the same versions of packages) and the pages render...
This is caused because of the following per-file options in the
api/files...If you remove the options and just leave the reference to the API in each file, i.e.
...and add the options globally under the
mkdocstringssection ofmkdocs.yml...then you shouldn't get the deprecation warning.