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

📚 [Documentation] - Switch from readthedocs.com to readthedocs.org #210

Closed
2 tasks
edwardchalstrey1 opened this issue Dec 18, 2024 · 2 comments
Closed
2 tasks
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@edwardchalstrey1
Copy link

Section of Documentation

All

Description of Improvement

I set up readthedocs such that the docs get built on PR and you can preview them, however I accidentally used the .com (business) which the trial subscription ends for on 25th December 2024, instead of .org (open source) readthedocs, so this will need to be switched over.

If it doesn't work, accept that there will be no docs previews on PR and reintroduce GH actions running the docs.yml workflow as a check, without preview (docs editors will have to build locally to check changes look good, but will still be able to know at the PR that at least they haven't broken anything).

Benefits of Improvement

Retain docs build on PRs

Additional Context

No response

Definition of Done

  • The documentation improvement has been developed on a branch.
  • A pull request has been created for the new branch to be merged into the dev branch.
@edwardchalstrey1 edwardchalstrey1 added bug Something isn't working documentation Improvements or additions to documentation labels Dec 18, 2024
@edwardchalstrey1 edwardchalstrey1 self-assigned this Dec 18, 2024
@edwardchalstrey1
Copy link
Author

Update: I have deleted the project and Seshat org on readthedocs.com

@edwardchalstrey1
Copy link
Author

Building on PR is enabled, however I get an error about attaching a webhook

Screenshot 2024-12-18 at 15 29 49

I can't see readthedocs.org so unsure how to fix this. Will just restore GH actions build for now - see #211

Screenshot 2024-12-18 at 15 30 51

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant