Closes #13688: added scroll to top button to div.footer via doc/_temp…

[shawnheide]

• closes DOCS/ENHANCEMENT: Scroll to top button in documentation #13688
• tests added / passed
• passes git diff upstream/master | flake8 --diff
• whatsnew entry

Added scroll to top feature to documentation div.footer using Sphinx template

[jreback]

I don't think this is the right template

[shawnheide]

I understand you suggested to add to the theme's main template, but adding it to the div.footer seems like a better approach since it's closer to the end of the page. Any other reason you think it's not the right template? Did you try building the docs and it didn't work?

[jreback]

well did the docs build?

[shawnheide]

Yes, they build just fine as far as I can tell and the code is inserted just above the </body>.

Here's the bottom of my build for index.html

    <style type="text/css">
    .scrollToTop {
        text-align: center;
        font-weight: bold;
        position: fixed;
        bottom: 60px;
        right: 40px;
        display: none;
    }
    </style>
    <a href="#" class="scrollToTop">Scroll To Top</a>
    <script type="text/javascript">
    $(document).ready(function() {
        //Check to see if the window is top if not then display button
        $(window).scroll(function() {
            if ($(this).scrollTop() > 200) {
                $('.scrollToTop').fadeIn();
            } else {
                $('.scrollToTop').fadeOut();
            }
        });

        //Click event to scroll to top
        $('.scrollToTop').click(function() {
            $('html, body').animate({
                scrollTop: 0
            }, 500);
            return false;
        });
    });
    </script>
</body>

[shawnheide]

@jreback, just curious if you had any other feedback on this

[jorisvandenbossche]

@shawnheide Can you explain again why this cannot be added to the doc/source/themes/nature_with_gtoc/static/layout.html ? Can't you add the footer there as well?

[jorisvandenbossche]

But to be clear, the enhancement itself is really nice!

[shawnheide]

@jorisvandenbossche No reason it couldn't be added. In all honesty I just got a little burnt out on Sphinx and didn't look into last week. I moved it to the theme as you and Jeff requested and changed the commit. Thanks for following up on this.

[codecov-io]

Current coverage is 84.53%

Merging #13689 into master will not change coverage

@@             master     #13689   diff @@
==========================================
  Files           141        141          
  Lines         51145      51145          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits          43233      43233          
  Misses         7912       7912          
  Partials          0          0          

Powered by Codecov. Last updated by 8acfad3...19ba380

[jorisvandenbossche]

@shawnheide Thanks!