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

Fix issues with PDF docs generation #256

Merged
merged 7 commits into from Sep 15, 2023
Merged

Fix issues with PDF docs generation #256

merged 7 commits into from Sep 15, 2023

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Sep 14, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • This PR does not seem to break the templates.
  • HISTORY.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Prevents PDF builds of the documentation (typically run after the linkcheck and html recipes have been built) from running the notebooks

Does this PR introduce a breaking change?

Yes. The notebooks will no longer be run when either of the following are true:

  • if env SKIP_NOTEBOOKS=1
  • if env "READTHEDOCS_VERSION_NAME" in ["latest", "stable"] or env "READTHEDOCS_VERSION_TYPE" == "tag"
    • and additionally, if env("READTHEDOCS_OUTPUT") in ["pdf"]

Other information:

https://docs.readthedocs.io/en/stable/reference/environment-variables.html

@Zeitsperre Zeitsperre added bug Something isn't working docs labels Sep 14, 2023
@Zeitsperre Zeitsperre self-assigned this Sep 14, 2023
@Zeitsperre Zeitsperre merged commit adafdbe into main Sep 15, 2023
12 checks passed
@Zeitsperre Zeitsperre deleted the FixTheDocs branch September 15, 2023 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants