8000 Docs building is broken - Read the docs project has it's default branch set to master instead of main · Issue #1547 · graphql-python/graphene-django · GitHub
[go: up one dir, main page]
Skip to content

Docs building is broken - Read the docs project has it's default branch set to master instead of main #1547

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
Open
CameronMackenzie99 opened this issue Apr 25, 2025 · 1 comment
Open

Docs building is broken - Read the docs project has it's default branch set to master instead of main #1547

CameronMackenzie99 opened this issue Apr 25, 2025 · 1 comment
Labels
🐛bug

Comments

@CameronMackenzie99
Copy link
CameronMackenzie99 commented Apr 25, 2025 •
edited
Loading

  • What is the current behavior?
    The RTD project is currently not building documentation for the last 1 year and two months (see RTD builds). I believe this coincides with moving from master to main as the default git branch, and this change not being reflected in the RTD project configuration.
    Upon inspection of the latest build we can see it failed due to a missing .readthedocs.yaml file. This was fixed in Fix ReadTheDocs builds #1509 by @PabloAlexis611 , but as noted in that PR, the configuration of the RTD project has not been changed due to lack of access.

  • What is the motivation to fix this bug?
    There have been fixes to various documentation error (e.g. in the tutorial) which have been merged, but not propagated to the latest doc site. This has created confusion with new issues being raised for already fixed docs issues, and means that the docs will become more outdated as new versions of graphene-django are released.

  • What is the fix?
    Setting the default branch in the RTD project to main should get the docs generating again as expected. From the project view here the list of maintainers are:
    @syrusakbary
    @ekampf
    @ProjectCheshire
    @mvanlonden

Would one of you be able to update the configuration of the project to build off the main branch? I'm happy to test that the configuration works once this has been updated. Thanks!
@CameronMackenzie99 CameronMackenzie99 changed the title Read the docs project default branch set to master instead of main Read the docs project has it's default branch set to master instead of main - docs don't build Apr 25, 2025
@CameronMackenzie99 CameronMackenzie99 changed the title Read the docs project has it's default branch set to master instead of main - docs don't build Docs building is broken - Read the docs project has it's default branch set to master instead of main Apr 25, 2025
@CameronMackenzie99
Copy link
Author

Bumping this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🐛bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CameronMackenzie99
0