Skip to content

Fix doc build #462

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

Merged
merged 12 commits into from
Nov 4, 2023
Merged

Fix doc build #462

merged 12 commits into from
Nov 4, 2023

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Nov 2, 2023

Description of the change

Doc builds are failing (see e.g. here)... They also failed for kikuchipy recently. I fixed this by installing a pandoc version compatible with nbconvert (nbsphinx dependency). (See here.) This PR installs an nbconvert-compatible version of pandoc.

Edit:
That's apparently not it. Errors and solutions found:

  • Initial doc build didn't pass reading of sources for orix.plot.AxAnglePlot. Apparently, the set() method inherited from Matplotlib's Axes class is not considered an inherited method. Sphinx therefore attempts to list this method in the API reference. This now fails. I've therefore explicitly excluded set() methods from the API reference for a class.

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.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@hakonanes hakonanes added the documentation Relates to the documentation label Nov 2, 2023
@hakonanes hakonanes added this to the v0.12.0 milestone Nov 2, 2023
@hakonanes hakonanes force-pushed the fix-doc-nbconvert-pandoc branch from cd19302 to ea79fa2 Compare November 2, 2023 18:50
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes force-pushed the fix-doc-nbconvert-pandoc branch from ea79fa2 to 6209359 Compare November 2, 2023 18:54
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes changed the title Install pandoc version compatible with nbconvert (nbsphinx) in docs Fix doc build Nov 3, 2023
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes requested review from harripj and pc494 November 3, 2023 15:26
Copy link
Collaborator

@harripj harripj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @hakonanes thanks for taking the time to implement the fix!

@hakonanes hakonanes merged commit 7d8600e into pyxem:develop Nov 4, 2023
@hakonanes hakonanes deleted the fix-doc-nbconvert-pandoc branch November 4, 2023 09:14
@hakonanes
Copy link
Member Author

Thank you for the quick review!

@pc494 pc494 mentioned this pull request Mar 26, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants