Skip to content
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

Merged
merged 12 commits into from
Jan 20, 2023
Merged

Add doctest step to docs build #3997

merged 12 commits into from
Jan 20, 2023

Conversation

IAlibay
Copy link
Member

@IAlibay IAlibay commented Jan 18, 2023

Enables #3925

Changes made in this Pull Request:

  • Adds a doctest CI step that will allow us to actually see progress towards [DOC] doctest MEGA-issue #3925
  • Moves linters out of the main CI file so it's a bit easier for us to see
  • Make it so that darker doesn't run on merge (that way we don't get failing badges)

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

@codecov
Copy link

codecov bot commented Jan 18, 2023

Codecov Report

Base: 93.50% // Head: 93.50% // No change to project coverage 👍

Coverage data is based on head (5dba3bf) compared to base (b36beba).
Patch has no changes to coverable lines.

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@IAlibay
Copy link
Member Author

IAlibay commented Jan 18, 2023

well darker lint shouldn't be skipping, something went wrong here...

@IAlibay
Copy link
Member Author

IAlibay commented Jan 18, 2023

Also need to fix the doctest call, keep-going isn't propagating properly

@hmacdope
Copy link
Member

hmacdope commented Jan 18, 2023

Great idea @IAlibay and also @richardjgowers who may have suggested

@IAlibay
Copy link
Member Author

IAlibay commented Jan 18, 2023

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.

Copy link
Member

@orbeckst orbeckst left a 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.

if: github.event_name == 'pull_request'
continue-on-error: true
run: |
cd package && python setup.py build_sphinx -b doctest --keep-going
Copy link
Member

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??

Copy link
Member Author

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.

Copy link
Member Author

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.

channel-priority: flexible
channels: conda-forge, bioconda
add-pip-as-python-dependency: true
uses-mamba: true
Copy link
Member

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']

Copy link
Member Author

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 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fixed now.

Copy link
Member

@hmacdope hmacdope left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @IAlibay, thanks for the addition. Will be a great help for #3925 and by extension GSOC szn.

Copy link
Member

@hmacdope hmacdope left a 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

@hmacdope
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@hmacdope
Copy link
Member

Seems ok now.

@IAlibay IAlibay merged commit 130e862 into develop Jan 20, 2023
@IAlibay IAlibay deleted the doctest-ci branch January 20, 2023 11:56
@RMeli RMeli mentioned this pull request Apr 10, 2023
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants