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.

Sign up for GitHub

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

Jump to bottom

Fix readthedocs build due to sphinx incompatibility with RTD theme #1063

Merged
merged 3 commits into from
Aug 9, 2023
Merged

Fix readthedocs build due to sphinx incompatibility with RTD theme #1063

merged 3 commits into from
Aug 9, 2023

Conversation

ejeschke
Copy link
Owner

@ejeschke ejeschke commented Aug 8, 2023

@ejeschke
add requirements.txt file
a41bd06 
- generated by:
  pip install pip-tools
  pip-compile --resolver=backtracking requirements.in
@ejeschke ejeschke requested a review from pllim August 8, 2023 23:14
@ejeschke ejeschke self-assigned this Aug 8, 2023
@ejeschke ejeschke added the maintenance Work done to keep code maintained label Aug 8, 2023
@ejeschke ejeschke added this to the 5.0 milestone Aug 8, 2023
@ejeschke
Copy link
Owner Author

ejeschke commented Aug 8, 2023

A bit hacky, but I guess we can revert it once sphinx 7.x supports the RTD theme. LMK what you think @pllim

@pllim
Copy link
Collaborator

pllim commented Aug 9, 2023

This seems a little excessive. Why not pin it here?

ginga/setup.cfg

Line 67 in cf22146

docs = sphinx-astropy; sphinx_rtd_theme

@ejeschke
Copy link
Owner Author

ejeschke commented Aug 9, 2023

This seems a little excessive. Why not pin it here?

ginga/setup.cfg

Line 67 in cf22146

docs = sphinx-astropy; sphinx_rtd_theme

If that works, I'm all for it! Can I say:

docs = sphinx<7.0, sphinx-astropy; sphinx_rtd_theme

?

@ejeschke
Copy link
Owner Author

ejeschke commented Aug 9, 2023

It works! LGTM, @pllim?

@ejeschke
Copy link
Owner Author

ejeschke commented Aug 9, 2023

I will squash out the previous commits.

pllim
pllim approved these changes Aug 9, 2023
View reviewed changes
Copy link
Collaborator

@pllim pllim left a comment

Choose a reason for hiding this comment

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

LGTM, FFTM. Thanks!

You can use the Squash and Merge button if you want.

@ejeschke ejeschke merged commit 0c7e215 into ejeschke:main Aug 9, 2023
7 checks passed
@ejeschke ejeschke deleted the fix-docbuild branch August 9, 2023 04:00
@ejeschke
Copy link
Owner Author

ejeschke commented Aug 9, 2023

Thanks, @pllim!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pllim pllim pllim approved these changes

Assignees

@ejeschke ejeschke

Labels
documentation maintenance Work done to keep code maintained
Projects
None yet
Milestone
5.0
Development

Successfully merging this pull request may close these issues.

RTD has error
2 participants
@ejeschke @pllim