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

MAINT/CI: Remove doctesting from refguide-check #20469

Merged
merged 1 commit into from May 15, 2024

Conversation

ev-br
Copy link
Member

@ev-br ev-br commented Apr 14, 2024

A follow-up to #20127 : remove doctesting part from the refguide-check tool.

The refguide-check itself then does three things instead of four:

  • check consistency of the refguide listings and actual package contents (that everything public is listed and private functions are not)
  • basic checks of ReST syntax of docstrings (I wonder if this part could/should go to numpydoc?)
  • scipy.stats-specific checks of kwarg name collisions.

This will need a rebase when gh-20127 lands, marking it as a draft until then.

@github-actions github-actions bot added scipy.stats scipy.io scipy.sparse.linalg scipy.sparse scipy.optimize scipy.ndimage scipy._lib Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.sparse.csgraph CI Items related to the CI tools such as CircleCI, GitHub Actions or Azure Cython Issues with the internal Cython code base labels Apr 14, 2024
@ev-br ev-br marked this pull request as draft April 14, 2024 07:44
@ev-br ev-br force-pushed the rip_doctesting_from_refguide_check branch from 5dd1bcc to b1fad4e Compare April 14, 2024 07:50
@lucascolley lucascolley removed scipy.ndimage scipy._lib scipy.sparse.csgraph Cython Issues with the internal Cython code base labels Apr 14, 2024
@lucascolley lucascolley changed the title Remove doctesting from refguide-check MAINT/CI: Remove doctesting from refguide-check Apr 14, 2024
Use $ python dev.py smoke-docs and dev.py smoke-tutorial instead
Both ways of running doctests, smoke-docs and refguide-check,
are avaiable in scipy#20127.

[docs only]
@ev-br ev-br force-pushed the rip_doctesting_from_refguide_check branch from b1fad4e to 18485a7 Compare May 15, 2024 14:48
@ev-br ev-br marked this pull request as ready for review May 15, 2024 14:49
@ev-br
Copy link
Member Author

ev-br commented May 15, 2024

CI is green, and this PR removes a now duplicate part of refguide-check, now that doctesting is split off in gh-20127.

@ev-br
Copy link
Member Author

ev-br commented May 15, 2024

Am going to merge straight away to avoid wasting CircleCI runs on duplicate work.

@ev-br ev-br merged commit 5410ea7 into scipy:main May 15, 2024
28 checks passed
@ev-br ev-br added this to the 1.14.0 milestone May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Items related to the CI tools such as CircleCI, GitHub Actions or Azure Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants