mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

#4965: Implement intelligent scrolling of the sidebar in the docs.

Browse source
This commit is contained in:
Ezio Melotti 2013-10-14 02:58:59 +03:00
parent 9e091e120b
commit 47fd9d8e09
2 changed files with 46 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/tools/sphinxext/static/basic.css
View file

@ -38,6 +38,8 @@ div.related li.right {
/* -- sidebar --------------------------------------------------------------- */ /* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper { div.sphinxsidebarwrapper {
position: relative;
top: 0;
padding: 10px 5px 0 10px; padding: 10px 5px 0 10px;
word-wrap: break-word; word-wrap: break-word;
} }

50
Doc/tools/sphinxext/static/sidebar.js
View file

@ -2,7 +2,8 @@
* sidebar.js * sidebar.js
* ~~~~~~~~~~ * ~~~~~~~~~~
* *
* This script makes the Sphinx sidebar collapsible. * This script makes the Sphinx sidebar collapsible and implements intelligent
* scrolling.
* *
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds in * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds in
* .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton used to * .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton used to
@ -24,6 +25,8 @@ $(function() {
// global elements used by the functions. // global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its // the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function // creation, in the add_sidebar_button function
var jwindow = $(window);
var jdocument = $(document);
var bodywrapper = $('.bodywrapper'); var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar'); var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper'); var sidebarwrapper = $('.sphinxsidebarwrapper');
@ -42,6 +45,13 @@ $(function() {
var dark_color = '#AAAAAA'; var dark_color = '#AAAAAA';
var light_color = '#CCCCCC'; var light_color = '#CCCCCC';
function get_viewport_height() {
if (window.innerHeight)
return window.innerHeight;
else
return jwindow.height();
}
function sidebar_is_collapsed() { function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)'); return sidebarwrapper.is(':not(:visible)');
} }
@ -51,6 +61,8 @@ $(function() {
expand_sidebar(); expand_sidebar();
else else
collapse_sidebar(); collapse_sidebar();
// adjust the scrolling of the sidebar
scroll_sidebar();
} }
function collapse_sidebar() { function collapse_sidebar() {
@ -95,11 +107,7 @@ $(function() {
); );
var sidebarbutton = $('#sidebarbutton'); var sidebarbutton = $('#sidebarbutton');
// find the height of the viewport to center the '<<' in the page // find the height of the viewport to center the '<<' in the page
var viewport_height; var viewport_height = get_viewport_height();
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
var sidebar_offset = sidebar.offset().top; var sidebar_offset = sidebar.offset().top;
var sidebar_height = Math.max(bodywrapper.height(), sidebar.height()); var sidebar_height = Math.max(bodywrapper.height(), sidebar.height());
sidebarbutton.find('span').css({ sidebarbutton.find('span').css({
@ -152,4 +160,34 @@ $(function() {
add_sidebar_button(); add_sidebar_button();
var sidebarbutton = $('#sidebarbutton'); var sidebarbutton = $('#sidebarbutton');
set_position_from_cookie(); set_position_from_cookie();
/* intelligent scrolling */
function scroll_sidebar() {
var sidebar_height = sidebarwrapper.height();
var viewport_height = get_viewport_height();
var offset = sidebar.position()['top'];
var wintop = jwindow.scrollTop();
var winbot = wintop + viewport_height;
var curtop = sidebarwrapper.position()['top'];
var curbot = curtop + sidebar_height;
// does sidebar fit in window?
if (sidebar_height < viewport_height) {
// yes: easy case -- always keep at the top
sidebarwrapper.css('top', $u.min([$u.max([0, wintop - offset - 10]),
jdocument.height() - sidebar_height - 200]));
}
else {
// no: only scroll if top/bottom edge of sidebar is at
// top/bottom edge of window
if (curtop > wintop && curbot > winbot) {
sidebarwrapper.css('top', $u.max([wintop - offset - 10, 0]));
}
else if (curtop < wintop && curbot < winbot) {
sidebarwrapper.css('top', $u.min([winbot - sidebar_height - offset - 20,
jdocument.height() - sidebar_height - 200]));
}
}
}
jwindow.scroll(scroll_sidebar);
}); });