-
Notifications
You must be signed in to change notification settings - Fork 200
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
✨ NEW: Option for download button #245
Conversation
Thanks for submitting your first pull request! You are awesome! 🤗 |
src/jinja/theme.conf.j2
Outdated
@@ -17,6 +17,7 @@ navbar_footer_text = | |||
extra_navbar = Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> | |||
extra_footer = | |||
use_issues_button = False | |||
use_download_button = False |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's set this to True
by default. I think that'll get the tests to pass. Though we should also add a test for this as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That did it :-)
sphinx_book_theme/theme.conf
Outdated
@@ -17,6 +17,7 @@ navbar_footer_text = | |||
extra_navbar = Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> | |||
extra_footer = | |||
use_issues_button = False | |||
use_repository_button = False | |||
use_download_button = False |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm - use_repository_button
should remain False
(the default that we currently have), and use_download_button
should be True
(also our current default behavior)
Can you also add documentation for this feature to https://github.com/executablebooks/sphinx-book-theme/blob/master/docs/configure.md ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I obviously edited the wrong line 🤦🏻♂️. I hope I got it right this time...
I'll proceed to the documentation and be back.
Another |
Thanks very much for this! RTD timeout errors fixed so let's get it in! |
@choldgraf I'm glad this feature was found useful, thanks for helping out :-). You mentioned above that a validation test would also be useful. I could work on this in the coming days when time permits but I need to dig a bit more on how to do this. What do you think? |
that would be great @bknaepen . I'd recommend checking out how the tests work for similar features: https://github.com/executablebooks/sphinx-book-theme/blob/master/tests/test_build.py#L217 and try to recreate those patterns. Wanna give that a shot? |
@choldgraf Yes I will try ;-) |
This relates to the following open issue:
#244
I am completely new to this package but this proposal seems to be functional. I just duplicated lines I found for the issue button.
The tests are failing but I was unable to fix this.