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

Added the ability to make the previous and next buttons hidden. #446

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ https://en.wikipedia.org/wiki/Lists_of_colors

-->

## 2022.05.29 -- Noble Nyanza

- Add ability to hide previous and next buttons

## 2022.04.07 -- Magical Mauve

- ✨ Make sphinx-copybutton look better.
Expand Down
6 changes: 3 additions & 3 deletions docs/customisation/edit-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ This is automatically added, when the documentation is generated on Read the Doc

```python
html_theme_options = {
"source_repository": "https://github.com/pradyunsg/furo/",
"source_branch": "main",
"source_directory": "docs/",
"source_repository": "https://github.com/pradyunsg/furo/",
"source_branch": "main",
"source_directory": "docs/",
}
```

Expand Down
1 change: 1 addition & 0 deletions docs/customisation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ html_theme_options = {
```

(top_of_page_button)=

### `top_of_page_button`

Controls which button is shown on the top of the page. The only supported values are `"edit"` (the default) and `None`.
Expand Down
2 changes: 2 additions & 0 deletions src/furo/theme/furo/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
</div>
<footer>
{% block footer %}
{%- if (theme_prev_next_buttons != 'hidden') %}
<div class="related-pages">
{% if next -%}
<a class="next-page" href="{{ next.link }}">
Expand Down Expand Up @@ -121,6 +122,7 @@
</a>
{%- endif %}
</div>
{%- endif %}
<div class="bottom-of-page">
<div class="left-details">
{%- if show_copyright %}
Expand Down
1 change: 1 addition & 0 deletions src/furo/theme/furo/theme.conf
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ light_logo =
sidebar_hide_name =
footer_icons =
top_of_page_button = edit
prev_next_buttons =
# For components/edit-this-page.html
source_repository =
source_branch =
Expand Down