Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit788b53d

Browse files
author
Jon Wayne Parrott
committed
Initial version of theme.
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.
1 parent6e7ed41 commit788b53d

File tree

13 files changed

+447
-203
lines changed

13 files changed

+447
-203
lines changed

‎LICENSE

Lines changed: 48 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,48 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "{}"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright 2017 Python Software Foundation
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
2+
--------------------------------------------
3+
4+
1. This LICENSE AGREEMENT is between the Python Software Foundation
5+
("PSF"), and the Individual or Organization ("Licensee") accessing and
6+
otherwise using this software ("Python") in source or binary form and
7+
its associated documentation.
8+
9+
2. Subject to the terms and conditions of this License Agreement, PSF hereby
10+
grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
11+
analyze, test, perform and/or display publicly, prepare derivative works,
12+
distribute, and otherwise use Python alone or in any derivative version,
13+
provided, however, that PSF's License Agreement and PSF's notice of copyright,
14+
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
15+
2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation; All Rights
16+
Reserved" are retained in Python alone or in any derivative version prepared by
17+
Licensee.
18+
19+
3. In the event Licensee prepares a derivative work that is based on
20+
or incorporates Python or any part thereof, and wants to make
21+
the derivative work available to others as provided herein, then
22+
Licensee hereby agrees to include in any such work a brief summary of
23+
the changes made to Python.
24+
25+
4. PSF is making Python available to Licensee on an "AS IS"
26+
basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
27+
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
28+
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
29+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
30+
INFRINGE ANY THIRD PARTY RIGHTS.
31+
32+
5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
33+
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
34+
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
35+
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
36+
37+
6. This License Agreement will automatically terminate upon a material
38+
breach of its terms and conditions.
39+
40+
7. Nothing in this License Agreement shall be deemed to create any
41+
relationship of agency, partnership, or joint venture between PSF and
42+
Licensee. This License Agreement does not grant permission to use PSF
43+
trademarks or trade name in a trademark sense to endorse or promote
44+
products or services of Licensee, or any third party.
45+
46+
8. By copying, installing or otherwise using Python, Licensee
47+
agrees to be bound by the terms and conditions of this License
48+
Agreement.

‎MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include LICENSE README.rst
2+
recursive-include python_docs_theme *.*

‎README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Python Docs Sphinx Theme
2+
=========================
3+
4+
This is the theme for the Python documentation

‎python_docs_theme/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
importos
2+
3+
4+
defsetup(app):
5+
current_dir=os.path.abspath(os.path.dirname(__file__))
6+
app.add_html_theme(
7+
'python_docs_theme',current_dir)

‎python_docs_theme/footerdonate.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% trans %}The Python Software Foundation is a non-profit corporation.{% endtrans %}
2+
<ahref="https://www.python.org/psf/donations/">{% trans %}Please donate.{% endtrans %}</a>
3+
<br/>

‎python_docs_theme/layout.html

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{% extends "classic/layout.html" %}
2+
3+
{% block rootrellink %}
4+
<li><imgsrc="{{ pathto('_static/' + theme_root_icon, 1) }}"alt=""
5+
style="vertical-align: middle; margin-top: -1px"/></li>
6+
<li><ahref="{{theme_root_url}}">{{theme_root_name}}</a>{{ reldelim1 }}</li>
7+
{% if theme_root_include_title %}
8+
<ahref="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}
9+
{% endif %}
10+
{% endblock %}
11+
12+
{%- macro searchbox() %}
13+
{# modified from sphinx/themes/basic/searchbox.html #}
14+
{%- if builder != "htmlhelp" %}
15+
<divclass="inline-search"style="display: none"role="search">
16+
<formclass="inline-search"action="{{ pathto('search') }}"method="get">
17+
<inputplaceholder="{{ _('Quick search') }}"type="text"name="q"/>
18+
<inputtype="submit"value="{{ _('Go') }}"/>
19+
<inputtype="hidden"name="check_keywords"value="yes"/>
20+
<inputtype="hidden"name="area"value="default"/>
21+
</form>
22+
</div>
23+
<scripttype="text/javascript">$('.inline-search').show(0);</script>
24+
{%- endif %}
25+
{%- endmacro %}
26+
27+
{% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %}
28+
{% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %}
29+
{% block relbaritems %}
30+
{%- if pagename != "search" and builder != "singlehtml" and builder != "htmlhelp" %}
31+
<liclass="right">
32+
{{ searchbox() }}
33+
{{ reldelim2 }}
34+
</li>
35+
{%- endif %}
36+
{% endblock %}
37+
38+
{% block extrahead %}
39+
<linkrel="shortcut icon"type="image/png"href="{{ pathto('_static/' + theme_root_icon, 1) }}"/>
40+
{% if builder != "htmlhelp" %}
41+
{% if not embedded %}<scripttype="text/javascript"src="{{ pathto('_static/copybutton.js', 1) }}"></script>{% endif %}
42+
{% endif %}
43+
{{ super() }}
44+
{% endblock %}
45+
46+
{% block footer %}
47+
<divclass="footer">
48+
&copy;<ahref="{{ pathto('copyright') }}">{% trans %}Copyright{% endtrans %}</a> {{ copyright|e }}.
49+
<br/>
50+
51+
{% include "footerdonate.html" %}
52+
<br/>
53+
54+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
55+
{% if theme_issues_url %}{% trans pathto_bugs=theme_issues_url %}<ahref="{{ theme_issues_url }}">Found a bug</a>?{% endtrans %}{% endif %}
56+
<br/>
57+
58+
{% trans sphinx_version=sphinx_version|e %}Created using<ahref="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
59+
</div>
60+
{% endblock %}
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
$(document).ready(function(){
2+
/* Add a [>>>] button on the top-right corner of code samples to hide
3+
* the >>> and ... prompts and the output and thus make the code
4+
* copyable. */
5+
vardiv=$('.highlight-python .highlight,'+
6+
'.highlight-python3 .highlight')
7+
varpre=div.find('pre');
8+
9+
// get the styles from the current theme
10+
pre.parent().parent().css('position','relative');
11+
varhide_text='Hide the prompts and output';
12+
varshow_text='Show the prompts and output';
13+
varborder_width=pre.css('border-top-width');
14+
varborder_style=pre.css('border-top-style');
15+
varborder_color=pre.css('border-top-color');
16+
varbutton_styles={
17+
'cursor':'pointer','position':'absolute','top':'0','right':'0',
18+
'border-color':border_color,'border-style':border_style,
19+
'border-width':border_width,'color':border_color,'text-size':'75%',
20+
'font-family':'monospace','padding-left':'0.2em','padding-right':'0.2em',
21+
'border-radius':'0 3px 0 0'
22+
}
23+
24+
// create and add the button to all the code blocks that contain >>>
25+
div.each(function(index){
26+
varjthis=$(this);
27+
if(jthis.find('.gp').length>0){
28+
varbutton=$('<span class="copybutton">&gt;&gt;&gt;</span>');
29+
button.css(button_styles)
30+
button.attr('title',hide_text);
31+
button.data('hidden','false');
32+
jthis.prepend(button);
33+
}
34+
// tracebacks (.gt) contain bare text elements that need to be
35+
// wrapped in a span to work with .nextUntil() (see later)
36+
jthis.find('pre:has(.gt)').contents().filter(function(){
37+
return((this.nodeType==3)&&(this.data.trim().length>0));
38+
}).wrap('<span>');
39+
});
40+
41+
// define the behavior of the button when it's clicked
42+
$('.copybutton').click(function(e){
43+
e.preventDefault();
44+
varbutton=$(this);
45+
if(button.data('hidden')==='false'){
46+
// hide the code output
47+
button.parent().find('.go, .gp, .gt').hide();
48+
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility','hidden');
49+
button.css('text-decoration','line-through');
50+
button.attr('title',show_text);
51+
button.data('hidden','true');
52+
}else{
53+
// show the code output
54+
button.parent().find('.go, .gp, .gt').show();
55+
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility','visible');
56+
button.css('text-decoration','none');
57+
button.attr('title',hide_text);
58+
button.data('hidden','false');
59+
}
60+
});
61+
});
62+

‎python_docs_theme/static/py.png

695 Bytes
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp