Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update ReadTheDocs builds configuration #11179

Merged
merged 3 commits into from
Sep 15, 2023

Conversation

MisRob
Copy link
Member

@MisRob MisRob commented Aug 29, 2023

Summary

  • Starting on September 25, ReadTheDocs builds without configuration file won't work anymore. This adds the configuration file.
  • Enables sphinx-rtd-theme for the production build
    • Previously, it was enabled only for local builds, probably because it was applied by default by ReadTheDocs. However, ReadTheDocs is generally moving towards requiring explicit configuration and having the theme disabled for production seems to be the cause of some recent troubles with theme on https://kolibri-dev.readthedocs.io/en/develop/

References

https://blog.readthedocs.com/migrate-configuration-v2/

Reviewer guidance

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@MisRob MisRob added the TODO: needs review Waiting for review label Sep 13, 2023
@MisRob MisRob requested a review from rtibbles September 13, 2023 14:04
@MisRob MisRob marked this pull request as ready for review September 13, 2023 14:05
@MisRob MisRob requested a review from radinamatic September 13, 2023 14:13
ReadTheDocs will soon stop supporting
projects with no configuration file.

https://blog.readthedocs.com/migrate-configuration-v2/
@MisRob MisRob removed the TODO: needs review Waiting for review label Sep 13, 2023
@MisRob MisRob marked this pull request as draft September 13, 2023 15:49
@MisRob MisRob changed the title Add the ReadTheDocs configuration file Update ReadTheDocs builds configuration Sep 15, 2023
The theme was previously enabled only for local
builds, probably because it was applied by default
by ReadTheDocs before they started shifting
towards requiring explicit configuration in general.
@github-actions github-actions bot added the DEV: backend Python, databases, networking, filesystem... label Sep 15, 2023
@MisRob MisRob marked this pull request as ready for review September 15, 2023 10:08
@MisRob MisRob added TODO: needs review Waiting for review TAG: developer docs Technical docs and code comments labels Sep 15, 2023
@rtibbles rtibbles merged commit 19c1d26 into learningequality:release-v0.16.x Sep 15, 2023
@MisRob MisRob deleted the docs-build branch February 29, 2024 08:41
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
DEV: backend Python, databases, networking, filesystem... SIZE: small TAG: developer docs Technical docs and code comments TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants