Skip to content

docs: update requirements for build on rtd #46

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

Merged
merged 1 commit into from
Feb 11, 2023

Conversation

dhellmann
Copy link
Contributor

@dhellmann dhellmann commented Feb 11, 2023

  • Add importlib_metadata dependency for older python versions, which
    seems to be what is used on RTD.
  • Split the docs job out of the other style jobs and pin the version
    of Python to force the use of the separate library in CI builds of
    docs.
  • Update the mergify rules accordingly.

See https://readthedocs.org/projects/virtualenvwrapper/builds/19455841/ for an example build failure.

Running Sphinx v1.8.6

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/virtualenvwrapper/envs/latest/lib/python3.7/site-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/home/docs/checkouts/readthedocs.org/user_builds/virtualenvwrapper/envs/latest/lib/python3.7/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/home/docs/checkouts/readthedocs.org/user_builds/virtualenvwrapper/checkouts/latest/docs/source/conf.py", line 16, in <module>
    import importlib.metadata
ModuleNotFoundError: No module named 'importlib.metadata'

- Add importlib_metadata dependency for older python versions, which
  seems to be what is used on RTD.
- Split the docs job out of the other style jobs and pin the version
  of Python to force the use of the separate library in CI builds of
  docs.
- Update the mergify rules accordingly.
@mergify mergify bot added Mergify changes to Mergify config documentation Improvements or additions to documentation labels Feb 11, 2023
@dhellmann dhellmann merged commit fa113fa into python-virtualenvwrapper:main Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Mergify changes to Mergify config
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant