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

Fix ReadTheDocs builds #1509

Merged
merged 2 commits into from Mar 29, 2024
Merged

Conversation

PabloAlexis611
Copy link
Contributor

Closes #1504

Here we just add the .readthedocs.yaml file at the root of the repo.
The basic configuration seems to work out-of-the-box.

I tested this on a fork of the ReadTheDocs build as well, which you can (for now) access here: https://graphene-django-pabloalexis611-fork.readthedocs.io/en/latest/

I will delete the RTD-fork once the PR gets merged.

Also, we may need to make sure that the graphene-django RTD project has main as it's "latest" branch setup correctly (which I don't have access to).

@PabloAlexis611
Copy link
Contributor Author

PabloAlexis611 commented Mar 24, 2024

@PabloAlexis611
Copy link
Contributor Author

Just fixed some references to the old master branch and switched them to main.

The main branch doesn't seem to be up yet in coveralls, so I didn't update those links for the coverage badge.

Copy link
Collaborator

@sjdemartini sjdemartini left a comment

Choose a reason for hiding this comment

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

I'm not super familiar with ReadTheDocs setup, but this LGTM. Thank you for adding this and for confirming that RTD is showing successful builds! I also don't have access to the RTD project for graphene-django, but seems like this would make sense to merge regardless.

@kiendang kiendang merged commit 3f813d4 into graphql-python:main Mar 29, 2024
12 checks passed
@PabloAlexis611 PabloAlexis611 deleted the fix-readthedocs branch March 30, 2024 04:45
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.

Read the docs is broken
3 participants