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

Mock import of tests module from package #89

Merged
merged 3 commits into from
Sep 12, 2023

Conversation

ianmkenney
Copy link
Member

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG.md updated?
  • AUTHORS.md updated?
  • Issue raised/referenced?

@lilyminium
Copy link
Member

Thanks @ianmkenney. Could you please add a line commenting what this does in the file?

If you've tested this locally by making a cookie and creating docs, would you mind uploading that to this PR as well? It's not somehting we look for in the CI (although perhaps it should be).

@ianmkenney
Copy link
Member Author

@lilyminium I ran into it when making the mdaencore docs. I couldn't find any other way to ignore a module in the autosummary directive.

Copy link
Member

@lilyminium lilyminium left a comment

Choose a reason for hiding this comment

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

I tested this by running the cookiecutter, and it removed tests for me -- thanks @ianmkenney! However, we should use the variable for the package name instead of the project.

{{cookiecutter.repo_name}}/docs/source/conf.py Outdated Show resolved Hide resolved
@ianmkenney ianmkenney merged commit 9cafdbb into MDAnalysis:main Sep 12, 2023
11 checks passed
@lilyminium
Copy link
Member

Thanks for merging, @ianmkenney! Just for next time, a "Request changes" review is conventionally blocking and requires resolution and re-review before merging -- my fault for not setting up the ruleset on this repo before this PR, but just explaining why I've done so now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated test module will be included by default in sphinx docs
2 participants