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

docs: fix build for latest theme #2274

Merged
merged 2 commits into from
Feb 28, 2023
Merged

docs: fix build for latest theme #2274

merged 2 commits into from
Feb 28, 2023

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented Feb 28, 2023

Fixes #2273

@agoose77 agoose77 temporarily deployed to docs-preview February 28, 2023 22:58 — with GitHub Actions Inactive
Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

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

You can merge it if the answer to the question below is "yes."

Comment on lines -1 to -4
{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}

{% block breadcrumbs_aside %}
{% endblock %}
Copy link
Member

Choose a reason for hiding this comment

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

We had a custom breadcrumbs.html to remove some feature, probably an "edit on GitHub" link that didn't work because of how things were set up. Is all of that obsolete now?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This currently doesn't do anything as we don't use sphinx_rtd_theme. However, pydata_sphinx_theme just added breadcrumbs, so now this no-op template loads and breaks things. We should probably re-introduce the feature that this template provided, on a more selective basis; generated listings, unlike the user guide, are not editable. I'll look into that in a new PR :)

@agoose77 agoose77 merged commit 3381567 into main Feb 28, 2023
@agoose77 agoose77 deleted the agoose77/docs-fix-build branch February 28, 2023 23:13
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.

Tests are failing in "Build Docs", possibly due to new Sphinx theme
2 participants