-
Notifications
You must be signed in to change notification settings - Fork 414
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
MAINT: Be nitpicky about docs #1437
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #1437 +/- ##
==========================================
- Coverage 94.77% 94.12% -0.65%
==========================================
Files 44 44
Lines 7306 7307 +1
==========================================
- Hits 6924 6878 -46
- Misses 382 429 +47
☔ View full report in Codecov by Sentry. |
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.
Nice, thanks for the fixes @larsoner !!
Do you recommend we have part of the CI that breaks when some nitpicks are not solved? (changing the readthedoc build command) This would avoid reintroducing errors?
Yes I would change the RTD build command. I can look into that or feel free to push a commit This fixes the original problem for me:
|
... actually IIRC the RTD stuff lives on the RTD site itself (?) so someone else might need to change it. I did at least make it that locally now it builds with |
@@ -118,7 +118,7 @@ def func_async(i, *args): | |||
############################################################################### | |||
# To have both fast pickling, safe process creation and serialization of | |||
# interactive functions, ``loky`` provides a wrapper function | |||
# :func:`wrap_non_picklable_objects` to wrap the non-picklable function and | |||
# ``wrap_non_picklable_objects`` to wrap the non-picklable function and |
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.
Locally for me at least this function had no docstring :(
Ok it seems to be run with Thanks a lot for fixing most of the errors @larsoner. |
Thx a lot @larsoner ! |
Closes #1436
SPHINXOPTS
wasn't used indoc/Makefile
, now it is so you can do stuff likemake clean && make html SPHINXOPTS="-nWT --keep-going -D sphinx_gallery_conf.filename_pattern=none"
SPHINXOPTS
to use-nWT --keep-geing
to be nitpickyThere are a few left I still need to sort out but this is at least close to working locally.