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

Derive project version using importlib #912

Merged

Conversation

ka28kumar
Copy link
Contributor

Fixes #628

Using importlib to populate the version field in conf.py

Copy link
Contributor

@seifertm seifertm left a comment

Choose a reason for hiding this comment

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

The doc build in the CI fails with the error importlib.metadata.PackageNotFoundError: No package metadata was found for pytest-asyncio. Probably because pytest-asyncio isn't installed in the Python environment used to build the docs.

You could try adding it to the installed packages in .readthedocs.yaml and see if it fixes the issue.

python:
  install:
    - path: .

see also: https://docs.readthedocs.io/en/stable/config-file/v2.html#python-install

@ka28kumar
Copy link
Contributor Author

Updated .readthedocs.yaml.
On a side note, is there a way to validate something like this locally?
I have little experience with ReadTheDocs and I couldn't find anything on this.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.30%. Comparing base (59afabf) to head (657330f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #912   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files           2        2           
  Lines         506      506           
  Branches       98       98           
=======================================
  Hits          462      462           
  Misses         26       26           
  Partials       18       18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@seifertm
Copy link
Contributor

Updated .readthedocs.yaml. On a side note, is there a way to validate something like this locally? I have little experience with ReadTheDocs and I couldn't find anything on this.

You're raising a very good point. It's desirable that the process for building the docs in the CI is the same as locally.
At the moment, this is not the case, though. I'll create an issue for that.

@seifertm
Copy link
Contributor

Created #917 to track the build issue.

@seifertm seifertm added this pull request to the merge queue Aug 13, 2024
@seifertm seifertm removed this pull request from the merge queue due to a manual request Aug 13, 2024
@seifertm seifertm added this pull request to the merge queue Aug 13, 2024
Merged via the queue into pytest-dev:main with commit ae30dac Aug 13, 2024
17 checks passed
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.

Derive project version in docs from Git Tags
3 participants