Adding Download and/or Fullscreen buttons

[hongkimsu]

Dear all!

I would like to ask if there is a possible way to add download and/or fullscreen buttons in the header? The buttons that are similar to the Sphinx-Book-Theme.

Thanks in advance!

[12rambau]

the fullscreen component could be added as a optional component quite easily. Now when I look at the download button, I don't really understand what are the expectations. Is to download the current page or the complete documentation pdf ?

If it's a single page are we looking as a print of the webpage or the Sphinx latex build ?

[12rambau]

creating a download button is not very dificult if you know where you want to point to. The main issue from the theme side is to guess what you want to download.

• pdf: it would mean that every page is built individually and send to the website (which is not the normal behaviour of Sphinx that build everything as a book)
• ipynb: you would need to know that the file was generated from a notebook using myst-nb or nbsphinx
• .md: that would only be valid if you use myst-nb, many documentation being based on .rst format.

In jupyterbook they can use this feature because they enforce the users to build the docs pages in specific format. I think this feature is unfortunately out of scope for the theme to download anything but the source (.rst format) or a print of the html rendered page. I'll let more active maintainers confirm this analysis.

[rickwierenga]

Sure. I can create a pr if you want?

[drammock]

I think this feature is unfortunately out of scope for the theme to download anything but the source (.rst format) or a print of the html rendered page. I'll let more active maintainers confirm this analysis.

This sounds basically correct to me. But I'll add that

1. there is a built-in mechanism in Sphinx for displaying the .rst source of the page (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink)
2. saving the HTML page as PDF is already handled by every major browser; at most I think we could consider adding some printing-specific CSS (https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Printing) to make those PDFs look nicer.

[rickwierenga]

how about downloading notebooks? this is a very useful function for many websites. why not copy the files over during the build process and provide a download link?

[drammock]

how about downloading notebooks?

I'm not sure what your use case is, but are you aware of https://sphinx-gallery.github.io ? It takes folder(s) of python scripts with interleaved rST text blocks, executes the code and embeds output in the HTML during the sphinx build, and also (optionally) injects a "download this page as .ipynb" link.