include LICENSE README.rst

recursive-include python_docs_theme *.*

Python Docs Sphinx Theme

This is the theme for the Python documentation

import os

def setup(app):

current_dir = os.path.abspath(os.path.dirname(__file__))

app.add_html_theme(

'python_docs_theme', current_dir)

{% trans %}The Python Software Foundation is a non-profit corporation.{% endtrans %}

<a href="https://www.python.org/psf/donations/">{% trans %}Please donate.{% endtrans %}</a>

<br />

{% extends "classic/layout.html" %}

{% block rootrellink %}

<li><img src="{{ pathto('_static/' + theme_root_icon, 1) }}" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="{{theme_root_url}}">{{theme_root_name}}</a>{{ reldelim1 }}</li>

{% if theme_root_include_title %}

<a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}

{% endif %}

{% endblock %}

{%- macro searchbox() %}

{# modified from sphinx/themes/basic/searchbox.html #}

{%- if builder != "htmlhelp" %}

<div class="inline-search" style="display: none" role="search">

<form class="inline-search" action="{{ pathto('search') }}" method="get">

<input placeholder="{{ _('Quick search') }}" type="text" name="q" />

<input type="submit" value="{{ _('Go') }}" />

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

</div>

<script type="text/javascript">$('.inline-search').show(0);</script>

{%- endif %}

{%- endmacro %}

{% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %}

{% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %}

{% block relbaritems %}

{%- if pagename != "search" and builder != "singlehtml" and builder != "htmlhelp" %}

<li class="right">

{{ searchbox() }}

{{ reldelim2 }}

</li>

{%- endif %}

{% endblock %}

{% block extrahead %}

<link rel="shortcut icon" type="image/png" href="{{ pathto('_static/' + theme_root_icon, 1) }}" />

{% if builder != "htmlhelp" %}

{% if not embedded %}<script type="text/javascript" src="{{ pathto('_static/copybutton.js', 1) }}"></script>{% endif %}

{% endif %}

{{ super() }}

{% endblock %}

{% block footer %}

<div class="footer">

&copy; <a href="{{ pathto('copyright') }}">{% trans %}Copyright{% endtrans %}</a> {{ copyright|e }}.

<br />

{% include "footerdonate.html" %}

<br />

{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

{% if theme_issues_url %}{% trans pathto_bugs=theme_issues_url %}<a href="{{ theme_issues_url }}">Found a bug</a>?{% endtrans %}{% endif %}

<br />

{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

</div>

{% endblock %}

$(document).ready(function() {

/* Add a [>>>] button on the top-right corner of code samples to hide

var div = $('.highlight-python .highlight,' +

'.highlight-python3 .highlight')

var pre = div.find('pre');

// get the styles from the current theme

pre.parent().parent().css('position', 'relative');

var hide_text = 'Hide the prompts and output';

var show_text = 'Show the prompts and output';

var border_width = pre.css('border-top-width');

var border_style = pre.css('border-top-style');

var border_color = pre.css('border-top-color');

var button_styles = {

'cursor':'pointer', 'position': 'absolute', 'top': '0', 'right': '0',

'border-color': border_color, 'border-style': border_style,

'border-width': border_width, 'color': border_color, 'text-size': '75%',

'font-family': 'monospace', 'padding-left': '0.2em', 'padding-right': '0.2em',

'border-radius': '0 3px 0 0'

}

// create and add the button to all the code blocks that contain >>>

div.each(function(index) {

var jthis = $(this);

if (jthis.find('.gp').length > 0) {

var button = $('<span class="copybutton">&gt;&gt;&gt;</span>');

button.css(button_styles)

button.attr('title', hide_text);

button.data('hidden', 'false');

jthis.prepend(button);

}

// tracebacks (.gt) contain bare text elements that need to be

// wrapped in a span to work with .nextUntil() (see later)

jthis.find('pre:has(.gt)').contents().filter(function() {

return ((this.nodeType == 3) && (this.data.trim().length > 0));

}).wrap('<span>');

});

// define the behavior of the button when it's clicked

$('.copybutton').click(function(e){

e.preventDefault();

var button = $(this);

if (button.data('hidden') === 'false') {

// hide the code output

button.parent().find('.go, .gp, .gt').hide();

button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'hidden');

button.css('text-decoration', 'line-through');

button.attr('title', show_text);

button.data('hidden', 'true');

} else {

// show the code output

button.parent().find('.go, .gp, .gt').show();

button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'visible');

button.css('text-decoration', 'none');

button.attr('title', hide_text);

button.data('hidden', 'false');

}

});