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

Temporarily disable PDF build #625

Merged
merged 4 commits into from
Mar 16, 2023
Merged

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Mar 15, 2023

Description of the change

This PR hopefully fixes the currently failing RTD PDF build by converting SVGs to supported formats. sphinx-doc/sphinx#1907 recommended using sphinx.ext.imgconverter, which converts automatically using imagemagick, so this is installed on the RTD server prior to building the docs.

The above is fixed, but PDF build errors, so we disable it for now.

Progress of the PR

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • New contributors are added to release.py, .zenodo.json and
    .all-contributorsrc with the table regenerated.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the documentation This relates to the documentation label Mar 15, 2023
@hakonanes hakonanes added this to the v0.9.0 milestone Mar 15, 2023
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Copy link
Member Author

hakonanes commented Mar 16, 2023

Decided to disable PDF build for now as the log displays no error except a message from latexmk stating there was some error (https://readthedocs.org/projects/kikuchipy-hakonanes/builds/19785794/). Closest related issue is readthedocs/readthedocs.org#10150.

@hakonanes hakonanes changed the title Use Sphinx extension imgconverter to convert SVGs in RTD PDF build Temporarily disable PDF build Mar 16, 2023
@hakonanes hakonanes merged commit f463aa1 into pyxem:develop Mar 16, 2023
@hakonanes hakonanes deleted the fix-rtd-pdf-build branch March 16, 2023 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant