Doc - use sphinx-multiproject for RTD subprojects #6197
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Orange3 documentation consists of multiple sphinx projects, which are built as subprojects at the Read the Docs. The documentation each subproject builds is set in advanced settings at RTD. That prevents us from using the
.readthedocs.yaml
file to set a higher version of Python since.readthedocs.yaml
overwrites all advanced settings.We need to change the version of Python used to build documentation (the default is 3.7) since we cannot increase some package versions in Orange.
Description of changes
In order to use
.readthedocs.yaml
to set a different version of Python, we need to set the documentation project somewhere outside the advanced settings in RTD. Using sphinx-multiproject enables us to set it as an environmental variable which does not get overwritten by.readthedocs.yaml
.Includes