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

Doc - use sphinx-multiproject for RTD subprojects #6197

Merged
merged 1 commit into from
Nov 19, 2022

Conversation

PrimozGodec
Copy link
Contributor

@PrimozGodec PrimozGodec commented Nov 11, 2022

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
  • Code changes
  • Tests
  • Documentation

@PrimozGodec PrimozGodec marked this pull request as draft November 11, 2022 12:30
@codecov
Copy link

codecov bot commented Nov 11, 2022

Codecov Report

Merging #6197 (d9588dc) into master (5b67ff8) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head d9588dc differs from pull request most recent head 55b4b0e. Consider uploading reports for the commit 55b4b0e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6197      +/-   ##
==========================================
- Coverage   86.65%   86.65%   -0.01%     
==========================================
  Files         315      316       +1     
  Lines       67976    67991      +15     
==========================================
+ Hits        58905    58917      +12     
- Misses       9071     9074       +3     

@PrimozGodec PrimozGodec changed the title Doc - Use sphinx-multiproject for RTD subprojects Doc - use sphinx-multiproject for RTD subprojects Nov 11, 2022
@PrimozGodec PrimozGodec marked this pull request as ready for review November 11, 2022 15:00
@markotoplak markotoplak merged commit f1726c2 into biolab:master Nov 19, 2022
@PrimozGodec PrimozGodec deleted the sphinx-multiproject branch August 29, 2023 11:03
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.

3 participants