✨ NEW: Option for download button

executablebooks · Nov 8, 2020 · a1fa391 · a1fa391
1 parent c784d06
commit a1fa391
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -97,6 +97,7 @@
     "use_edit_page_button": True,
     "use_issues_button": True,
     "use_repository_button": True,
+    "use_download_button": True,
     # For testing
     # "home_page_in_toc": True,
     # "single_page": True,

diff --git a/docs/configure.md b/docs/configure.md
@@ -87,6 +87,17 @@ html_theme_options = {
     ...
 }
 ```
+## Download page button
+
+You can add a button allowing users to download the currently viewed page in several formats: raw, pdf or ipynb if available. To include this button, use the following configuration:
+
+```python
+html_theme_options = {
+    ...
+    "use_download_button": True,
+    ...
+}
+```
 
 ## Use a single-page version of this theme
 

diff --git a/sphinx_book_theme/__init__.py b/sphinx_book_theme/__init__.py
@@ -316,6 +316,7 @@ def add_header_level_recursive(ul, level):
         "theme_use_edit_page_button",
         "theme_use_repository_button",
         "theme_use_issues_button",
+        "theme_use_download_button",
     ]
     for key in btns:
         if key in context:

diff --git a/sphinx_book_theme/theme.conf b/sphinx_book_theme/theme.conf
@@ -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 = True
 use_repository_button = False
 theme_dev_mode = False
 show_navbar_depth = 1
diff --git a/sphinx_book_theme/topbar/download.html b/sphinx_book_theme/topbar/download.html
@@ -1,8 +1,8 @@
+{% if page_source_suffix and theme_use_download_button %}
 <div class="dropdown-buttons-trigger">
     <button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="{{ translate('Download this page') }}"><i
             class="fas fa-download"></i></button>
 
-    {% if page_source_suffix %}
     <div class="dropdown-buttons">
         <!-- ipynb file if we had a myst markdown file -->
         {% if ipynb_source %}<a class="dropdown-buttons"
@@ -17,5 +17,5 @@
         <button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="{{ translate('Print to PDF') }}"
             onClick="window.print()" data-toggle="tooltip" data-placement="left">.pdf</button>
     </div>
-    {% endif %}
 </div>
+{% endif %}
diff --git a/src/jinja/theme.conf.j2 b/src/jinja/theme.conf.j2
@@ -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 = True
 use_repository_button = False
 theme_dev_mode = False
 show_navbar_depth = 1