Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork67
Initial version of theme.#1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes from1 commit
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
Extracted from CPython @ 1bced5656Added a few more theme config values, split the donate footer into its own template, and removed CPython-docs sepcific JavaScript and HTML.
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,201 +1,48 @@ | ||
PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 | ||
-------------------------------------------- | ||
1. This LICENSE AGREEMENT is between the Python Software Foundation | ||
("PSF"), and the Individual or Organization ("Licensee") accessing and | ||
otherwise using this software ("Python") in source or binary form and | ||
its associated documentation. | ||
2. Subject to the terms and conditions of this License Agreement, PSF hereby | ||
grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, | ||
analyze, test, perform and/or display publicly, prepare derivative works, | ||
distribute, and otherwise use Python alone or in any derivative version, | ||
provided, however, that PSF's License Agreement and PSF's notice of copyright, | ||
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, | ||
2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation; All Rights | ||
Reserved" are retained in Python alone or in any derivative version prepared by | ||
Licensee. | ||
3. In the event Licensee prepares a derivative work that is based on | ||
or incorporates Python or any part thereof, and wants to make | ||
the derivative work available to others as provided herein, then | ||
Licensee hereby agrees to include in any such work a brief summary of | ||
the changes made to Python. | ||
4. PSF is making Python available to Licensee on an "AS IS" | ||
basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR | ||
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND | ||
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS | ||
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT | ||
INFRINGE ANY THIRD PARTY RIGHTS. | ||
5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON | ||
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS | ||
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, | ||
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. | ||
6. This License Agreement will automatically terminate upon a material | ||
breach of its terms and conditions. | ||
7. Nothing in this License Agreement shall be deemed to create any | ||
relationship of agency, partnership, or joint venture between PSF and | ||
Licensee. This License Agreement does not grant permission to use PSF | ||
trademarks or trade name in a trademark sense to endorse or promote | ||
products or services of Licensee, or any third party. | ||
8. By copying, installing or otherwise using Python, Licensee | ||
agrees to be bound by the terms and conditions of this License | ||
Agreement. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
include LICENSE README.rst | ||
recursive-include python_docs_theme *.* |
This file was deleted.
Uh oh!
There was an error while loading.Please reload this page.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Python Docs Sphinx Theme | ||
========================= | ||
This is the theme for the Python documentation | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The note from the python-dev discussion can just be added here as a second paragraph:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Done, thank you. :) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import os | ||
def setup(app): | ||
current_dir = os.path.abspath(os.path.dirname(__file__)) | ||
app.add_html_theme( | ||
'python_docs_theme', current_dir) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{% 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 /> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
{% 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"> | ||
© <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 %} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
$(document).ready(function() { | ||
/* Add a [>>>] button on the top-right corner of code samples to hide | ||
* the >>> and ... prompts and the output and thus make the code | ||
* copyable. */ | ||
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">>>></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'); | ||
} | ||
}); | ||
}); | ||
Uh oh!
There was an error while loading.Please reload this page.