-
Notifications
You must be signed in to change notification settings - Fork 670
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
Add doctest step to docs build #3997
Conversation
Codecov ReportBase: 93.50% // Head: 93.50% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## develop #3997 +/- ##
========================================
Coverage 93.50% 93.50%
========================================
Files 190 190
Lines 24943 24943
Branches 3523 3523
========================================
Hits 23322 23322
Misses 1100 1100
Partials 521 521 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
well darker lint shouldn't be skipping, something went wrong here... |
Also need to fix the doctest call, keep-going isn't propagating properly |
Great idea @IAlibay and also @richardjgowers who may have suggested |
Ok that should be all addressed - that's 372 test failures (out of 388 it seems...). It won't fail but at least it'll give us a place to look at how things have improved / worsened based on a given PR. |
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.
I like the modularization and the use of a separate badge.
I could give it a "LGTM" if necessary but would prefer other folks with stronger opinions on the matter than myself (@hmacdope @jbarnoud @richardjgowers ...) to weigh in.
.github/workflows/gh-ci.yaml
Outdated
if: github.event_name == 'pull_request' | ||
continue-on-error: true | ||
run: | | ||
cd package && python setup.py build_sphinx -b doctest --keep-going |
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.
I think python setup.py build_sphinx
has been deprecated because setup.py does not want to be a build system (or something like that). Is there an alternative for invoking doctests??
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.
I think setuptools isn't as harsh on the deprecation here, but I'll try switching to sphinx-build instead and see what happens.
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.
That should do the trick. I'd probably say we should do the docs building & deployment elsewhere? I'm a bit apprehensive of changing that right now and then unleashing a whole other set of problems.
.github/workflows/linters.yaml
Outdated
channel-priority: flexible | ||
channels: conda-forge, bioconda | ||
add-pip-as-python-dependency: true | ||
uses-mamba: true |
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.
Error/warning message
Unexpected input(s) 'uses-mamba', valid inputs are ['installer-url', 'miniconda-version', 'miniforge-variant', 'miniforge-version', 'conda-version', 'conda-build-version', 'environment-file', 'activate-environment', 'python-version', 'add-anaconda-token', 'add-pip-as-python-dependency', 'allow-softlinks', 'auto-activate-base', 'auto-update-conda', 'condarc-file', 'channel-alias', 'channel-priority', 'channels', 'show-channel-urls', 'use-only-tar-bz2', 'remove-profiles', 'mamba-version', 'use-mamba', 'architecture', 'clean-patched-environment-file', 'run-post']
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.
use-mamba
I think I've been making a typo everywhere 😅
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.
Should be fixed now.
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.
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.
Not sure what is going on with Azure CI
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Seems ok now. |
Enables #3925
Changes made in this Pull Request:
PR Checklist