mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
3b01fbe2ad
* Delete jQuery and underscore.js * Move underscores.js setup to searchtools.js * Update jQuery.url(en|de)code * Update jQuery.getQueryParameters * Firefox bug is no longer present xref https://bugzilla.mozilla.org/show_bug.cgi?id=645075#c49 * Update jQuery.fn.highlightText * Use enum instead of magic number * Update test descriptions to remove obsolete jQuery reference * Update Documentation.getCurrentURL * Revert accidental fix of Documentation.getCurrentURL * Update Documentation.initOnKeyListeners * Update Documentation.hideSearchWords * Update Documentation.highlightSearchWords * Update Documentation.initDomainIndexTable * Use arrow functions and const * Replace $(document).ready * Strict mode * Move Documentation.hideSearchWords next to Documentation.highlightSearchWords * Update translation functions in Documentation * Replace $(document).ready in searchtools.js * Update Scorer * Update Search.hasIndex, Search.deferQuery, Search.stopPulse * Prefer window.location * Update Search.init * Update Search.loadIndex * Update Search.setIndex * Update Search.startPulse * Add _escapeRegExp * Update Search.makeSearchSummary * Update Search.htmlToText * Update Search.performSearch * Factor out _displayNextItem * Update Search.query * Update Search.performObjectSearch * Update Search.performTermsSearch * Remove underscores.js setup * Use Sets * Update test configuration * Fix test failures * Drop unused make/get URL functions * Strict mode in searchtools.js * Remove outmoded check for jQuery and underscore.js * Ran prettier prettier --print-width 120 --no-semi --quote-props as-needed --no-bracket-spacing --arrow-parens avoid --write sphinx/themes/basic/static * Remove more references to jQuery and underscore.js * Remove jQuery and underscore.js licences * Update classic theme for no jQuery * Update all other themes for no jQuery * Restore jQuery & underscores.js to Sphinx themes Enables a more gradual deprecation * Added deprecation note to CHANGES * Run prettier with defaults * Update deprecation message to include extensions, note that sources must be copied * oops * Address Pradyun's feedback * Forgot this one * `let` doesn't work, as it is scoped to the block... * Remove missed jQuery in sphinx13 theme
76 lines
2.6 KiB
HTML
76 lines
2.6 KiB
HTML
{#
|
|
sphinxdoc/layout.html
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Sphinx layout template for the sphinxdoc theme.
|
|
|
|
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
#}
|
|
{%- extends "basic/layout.html" %}
|
|
|
|
{# put the sidebar before the body #}
|
|
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
|
|
{% block sidebar2 %}{% endblock %}
|
|
|
|
{% block extrahead %}
|
|
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
|
|
rel='stylesheet' type='text/css' />
|
|
{{ super() }}
|
|
{%- if not embedded %}
|
|
<style type="text/css">
|
|
table.right { float: right; margin-left: 20px; }
|
|
table.right td { border: 1px solid #ccc; }
|
|
{% if pagename == 'index' %}
|
|
.related { display: none; }
|
|
{% endif %}
|
|
</style>
|
|
<script>
|
|
// intelligent scrolling of the sidebar content
|
|
window.onscroll = () => {
|
|
const sb = document.getElementsByClassName('sphinxsidebarwrapper')[0]
|
|
const sbh = sb.offsetHeight
|
|
const offset = document.getElementsByClassName('sphinxsidebar')[0].offsetTop;
|
|
const wintop = window.scrollTop;
|
|
const winbot = wintop + window.offsetHeight
|
|
const curtop = sb.offsetTop;
|
|
const curbot = curtop + sbh;
|
|
// does sidebar fit in window?
|
|
if (sbh < window.offsetHeight) {
|
|
// yes: easy case -- always keep at the top
|
|
sb.style.top = Math.min(Math.max(0, wintop - offset - 10), window.innerHeight - sbh - 200)
|
|
} else {
|
|
// no: only scroll if top/bottom edge of sidebar is at
|
|
// top/bottom edge of window
|
|
if (curtop > wintop && curbot > winbot) {
|
|
sb.style.top = Math.max(wintop - offset - 10, 0)
|
|
} else if (curtop < wintop && curbot < winbot) {
|
|
sb.style.top = Math.min(winbot - sbh - offset - 20, window.innerHeight - sbh - 200)
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
{%- endif %}
|
|
{% endblock %}
|
|
|
|
{% block rootrellink %}
|
|
<li><a href="{{ pathto('index') }}">Sphinx home</a> |</li>
|
|
<li><a href="{{ pathto('contents') }}">Documentation</a> »</li>
|
|
{% endblock %}
|
|
|
|
{% block header %}
|
|
<div class="pageheader">
|
|
<ul>
|
|
<li><a href="{{ pathto('index') }}">Home</a></li>
|
|
<li><a href="{{ pathto('usage/installation') }}">Get it</a></li>
|
|
<li><a href="{{ pathto('contents') }}">Docs</a></li>
|
|
<li><a href="{{ pathto('development/index') }}">Extend</a></li>
|
|
</ul>
|
|
<div>
|
|
<a href="{{ pathto('index') }}">
|
|
<img src="{{ pathto('_static/sphinxheader.png', 1) }}" alt="SPHINX" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
{% endblock %}
|