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

Read The Docs and dependency upgrades #3535

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

JimMadge
Copy link
Member

@JimMadge JimMadge commented Feb 20, 2024

Summary

Fixes #3509 #3513
Supercedes #3512

Move book to ReadTheDocs build, updating packages.

Build from my fork is here

Important build changes

  • Python 3.12
  • Sphinx v5
  • Jupyter Book v1

This will fail to build on the Netlify runner as that only has Python 3.8.

List of changes proposed in this PR (pull-request)

  • Add ReadTheDocs configuration
  • Update packages (removing DOS vulnerability)
  • Adjust pathways command so it can be used as a pre-build step in rtd
  • Pin requirements using pip-tools
  • Fix build bugs

What should a reviewer concentrate their feedback on?

  • Everything looks ok?

Acknowledging contributors

@JimMadge JimMadge added the infrastructure For all issues related to book infrastructure label Feb 20, 2024
Copy link

netlify bot commented Feb 20, 2024

Deploy Preview for the-turing-way failed.

Name Link
🔨 Latest commit 3199831
🔍 Latest deploy log https://app.netlify.com/sites/the-turing-way/deploys/65d4bd2a385dad0008c4d32a

@JimMadge JimMadge changed the title ReadTheDocs [DO NOT MERGE (yet)] ReadTheDocs Feb 20, 2024
@JimMadge JimMadge marked this pull request as draft February 20, 2024 11:52
@JimMadge JimMadge changed the title [DO NOT MERGE (yet)] ReadTheDocs Read The Docs Feb 20, 2024
@JimMadge JimMadge changed the title Read The Docs Read The Docs and dependency upgrades Feb 20, 2024
@aleesteele
Copy link
Member

@JimMadge - Following up from Collab Cafe, I'll comment on the original issue with some suggestions about how to document our move to RTD!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure For all issues related to book infrastructure
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Sphinx v5 and migration from Netlify
2 participants