Skip to content

Readthedocs build instructions#540

Merged
tturocy merged 4 commits intomasterfrom
readthedocs-build-instructions
Aug 7, 2025
Merged

Readthedocs build instructions#540
tturocy merged 4 commits intomasterfrom
readthedocs-build-instructions

Conversation

@edwardchalstrey1
Copy link
Copy Markdown
Member

@edwardchalstrey1 edwardchalstrey1 commented Aug 5, 2025

TODO:

@tturocy
Copy link
Copy Markdown
Member

tturocy commented Aug 5, 2025

This is configured on the readthedocs side, so those builds are automated once we've pushed to GitHub. But that only works for branches we've activated. So testing the build online for proposed changes isn't as straightforward - one can of course build locally but that requires installing sphinx and in any event sometimes the local builds work and then the online one doesn't because of environment differences.

@edwardchalstrey1
Copy link
Copy Markdown
Member Author

This is configured on the readthedocs side, so those builds are automated once we've pushed to GitHub. But that only works for branches we've activated. So testing the build online for proposed changes isn't as straightforward - one can of course build locally but that requires installing sphinx and in any event sometimes the local builds work and then the online one doesn't because of environment differences.

Great, thanks for explaining, I've opened #543 to look into automating this, in the meantime I think we can merge these local build instructions that worked for me

@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review August 6, 2025 10:20
@edwardchalstrey1 edwardchalstrey1 moved this from In progress to In review in Ed Chalstrey Gambit priorities Aug 7, 2025
@tturocy tturocy merged commit 6436ed3 into master Aug 7, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in Ed Chalstrey Gambit priorities Aug 7, 2025
@tturocy tturocy deleted the readthedocs-build-instructions branch August 7, 2025 21:15
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.

2 participants