Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork66
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
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
249 changes: 48 additions & 201 deletionsLICENSE
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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. |
2 changes: 2 additions & 0 deletionsMANIFEST.in
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
include LICENSE README.rst | ||
recursive-include python_docs_theme *.* |
2 changes: 0 additions & 2 deletionsREADME.md
This file was deleted.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
11 changes: 11 additions & 0 deletionsREADME.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Python Docs Sphinx Theme | ||
========================= | ||
This is the theme for the Python documentation. | ||
Note that when adopting this theme, you're also borrowing an element of the | ||
trust and credibility established by the CPython core developers over the | ||
years. That's fine, and you're welcome to do so for other Python community | ||
projects if you so choose, but please keep in mind that in doing so you're also | ||
choosing to accept some of the responsibility for maintaining that collective | ||
trust. |
7 changes: 7 additions & 0 deletionspython_docs_theme/__init__.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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) |
3 changes: 3 additions & 0 deletionspython_docs_theme/footerdonate.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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 /> |
60 changes: 60 additions & 0 deletionspython_docs_theme/layout.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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 %} |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.