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

Enable documentation download in pdf format #3253

Merged
merged 3 commits into from
Dec 16, 2024
Merged

Conversation

So-Fras
Copy link
Member

@So-Fras So-Fras commented Dec 11, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines

What kind of change does this PR introduce?
Documentation configuration update: allows to download readthedocs documentation in pdf format.

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

Other information
Readthedocs documentation on this subject is available here.

@So-Fras
Copy link
Member Author

So-Fras commented Dec 11, 2024

image
Test before merge on main:

  • The flyout menu is not displayed when locally building the documentation.
  • Solution: change the default branch in the project page to download_readthedocs branch and use latest version on the documentation page

@olperr1
Copy link
Member

olperr1 commented Dec 16, 2024

Test before merge on main:

  • The flyout menu is not displayed when locally building the documentation.
  • Solution: change the default branch in the project page to download_readthedocs branch and use latest version on the documentation page

This only works when the last readthedocs compilation concerns this branch.
(And changing the default branch may not be needed.)

@olperr1 olperr1 merged commit b59a203 into main Dec 16, 2024
8 checks passed
@olperr1 olperr1 deleted the download_readthedocs branch December 16, 2024 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants