Add doc hosting on readthedocs #83
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dstansby
force-pushed
the
readthedocs
branch
7 times, most recently
from
8378c88 to
2c1bd8c
Compare
|
As per #18 (comment), this isn't working and I'm going to close this PR. Bits can always be adapted for an attempt at hosting on GitHub pages. |
[pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci
samcunliffe
reviewed
May 10, 2023
| "image_scrapers": (qtgallery.qtscraper,), | ||
| "reset_modules": (qtgallery.reset_qapp,), | ||
| # Don't run any gallery examples, because they're not working on | ||
| # readthedocs at the moment |
There was a problem hiding this comment.
😭 But it was so nice.
What was the problem? I assume it's not a problem of xfvb on rtd?
There was a problem hiding this comment.
I'm not sure, but xvfb just kept crashing. Might be due to some leaking/non-closed widgets, but the error message wasn't helpful enough to make a more educated guess.
There was a problem hiding this comment.
I guess we would need sudo access to a headless 18.04 VM to try it ourselves?
| tools: | ||
| python: "3.10" | ||
| apt_packages: | ||
| - xvfb |
There was a problem hiding this comment.
... And qtgallery's README says to do what you're doing.
samcunliffe
approved these changes
May 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #18. This is a minimal config to get the docs building and hosted. The gallery build is disabled becaus I can't get it to work, but I think it's worth merging this as is so we can work on fixing the gallery and improving the rest of the docs in parallel.