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

Update Sphinx compile issue after upgrading to Python 3.9 and related packages. #180

Closed
5 tasks done
yhan818 opened this issue Jul 8, 2022 · 0 comments
Closed
5 tasks done
Assignees
Labels
enhancement New feature or request

Comments

@yhan818
Copy link
Contributor

yhan818 commented Jul 8, 2022

Summary

RTD https://readthedocs.org/projects/redata-commons/ build success at the workflow (using Python 3.8) under "Actions", but it failed in readthedocs.org website with the latest Pandas 1.4.3.
This is a chain of actions from upgrading from Python 3.7 to Python 3.9. See UAL-RE/redata-commons#23

This is a similar issue to one at redata-commons (UAL-RE/redata-commons#32)
in docs/requirements.txt:
Sphinx 4.0 ==> 5.0.0
sphinx-rtd-theme 0.5.1 ==> 1.0.0
sphinx-autodoc-typehints 1.11.1 ==> 1.18.3

Objectives

Update Sphinx dependencies to the latest version and the same version as other ReDATA repositories, because the latest versions are maintained and previous versions may not be maintained (i.e. issues, security patches).

Proposal

  • Update requirements.txt
  • Add a new file at the root .readthedocs.yaml
  • Update Sphinx dependencies

Testing notes

Additional notes

RTD configuration file https://docs.readthedocs.io/en/stable/config-file/v2.html

Implemented in: TBD

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

No branches or pull requests

1 participant