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

Add back next and previous buttons to footer #181

Merged
merged 4 commits into from
Feb 9, 2023

Conversation

javabster
Copy link
Collaborator

In an earlier version of the theme we removed the "Next" and "Previous" buttons in the footer. In response to user requests and further discussion we have decided to add that component back.

fixes #174

In this PR:

  • added back the original code for the next/previous buttons
  • added a small line break at the very end of the footer so that the copyright text doesn't sit so close to the edge of the page.

Screenshot 2023-02-09 at 2 52 40 PM

@javabster javabster added this to the Qiskit Sphinx Theme v1.12.0 milestone Feb 9, 2023
Copy link
Contributor

@HuangJunye HuangJunye left a comment

Choose a reason for hiding this comment

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

Looking at the old footer.html, it has theme_prev_next_buttons_location environment variable to specify the location. breadcrumb.html still has such logic to show on the top. Do you want add the condtion back?

@HuangJunye
Copy link
Contributor

A quick check, the meta doc and nature doc sets `'prev_next_buttons_location': 'bottom'

So practically remove the conditions won't change anything, but I think we can simply revert it back to the old version and let individual repo to decide where to put the button.

@javabster
Copy link
Collaborator Author

I can't see that variable being used anywhere from the qiskit repo side, i think it's used to specify where on the page the buttons are located so I don't think we need them as (I assume) we always want the buttons to be placed at the bottom of the page.

Also I have an open issue for cleaning up the breadcrumbs file, it was one of the few I didn't get round to cleaning up before the last big release we did

@HuangJunye
Copy link
Contributor

I can't see that variable being used anywhere from the qiskit repo side]

It's used at least for qiskit meta and qiskit-nature, probably other repos too.

@HuangJunye
Copy link
Contributor

I tested building using prev_next_buttons_location = 'top' release 1.8.7 which is before the the layout refactor #119 and the buttons are broken. So if we want to add that option, we need to fix breadcrumb.html as well.

image

Source: html.zip

And a quick search on the qiskit github org, all repos that uses prev_next_buttons_location only sets it to bottom so I agree with that we can go ahead and remove the conditions.

@HuangJunye HuangJunye merged commit 739fcdb into Qiskit:main Feb 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add next page button
2 participants