Skip to content

Commit c8461d8

Browse files
sgryjpsgryjp
committed
Now uses Sphinx theme feature.
Django 1.4のドキュメントがそうしているように、Sphinxのテーマ機能を使用するよう に修正。具体的な内訳は以下の通り: - conf.py を1.4のもので上書きした上で language='ja' を設定 - Makefile を1.4のもので上書き - _theme/theme.conf を1.4の内容でそのままコピー - _templates/*.html を _theme/djangodocs/ に移動 - 1.0〜1.4間で複数の修正が入っているのでそれも適用 (修正適用しないとHTMLをビルドできない) - _static/* を _theme/djangodocs/static/ に移動
1 parent 3730c8d commit c8461d8

14 files changed

+299
-73
lines changed

‎Makefile

Lines changed: 92 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,66 +5,126 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8+
BUILDDIR = _build
89

910
# Internal variables.
1011
PAPEROPT_a4 = -D latex_paper_size=a4
1112
PAPEROPT_letter = -D latex_paper_size=letter
12-
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1314

14-
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
1516

1617
help:
1718
@echo "Please use \`make <target>' where <target> is one of"
18-
@echo " html to make standalone HTML files"
19-
@echo " pickle to make pickle files (usable by e.g. sphinx-web)"
20-
@echo " htmlhelp to make HTML files and a HTML help project"
21-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
22-
@echo " changes to make an overview over all changed/added/deprecated items"
23-
@echo " linkcheck to check all external links for integrity"
19+
@echo " html to make standalone HTML files"
20+
@echo " dirhtml to make HTML files named index.html in directories"
21+
@echo " singlehtml to make a single large HTML file"
22+
@echo " pickle to make pickle files"
23+
@echo " json to make JSON files"
24+
@echo " htmlhelp to make HTML files and a HTML help project"
25+
@echo " qthelp to make HTML files and a qthelp project"
26+
@echo " devhelp to make HTML files and a Devhelp project"
27+
@echo " epub to make an epub"
28+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30+
@echo " text to make text files"
31+
@echo " man to make manual pages"
32+
@echo " changes to make an overview of all changed/added/deprecated items"
33+
@echo " linkcheck to check all external links for integrity"
34+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
2435

2536
clean:
26-
-rm -rf _build/*
37+
-rm -rf $(BUILDDIR)/*
2738

2839
html:
29-
mkdir -p _build/html _build/doctrees
30-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
40+
$(SPHINXBUILD) -b djangohtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
3141
@echo
32-
@echo "Build finished. The HTML pages are in _build/html."
42+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43+
44+
dirhtml:
45+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48+
49+
singlehtml:
50+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51+
@echo
52+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
3353

3454
pickle:
35-
mkdir -p _build/pickle _build/doctrees
36-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
55+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
3756
@echo
38-
@echo "Build finished; now you can process the pickle files or run"
39-
@echo " sphinx-web _build/pickle"
40-
@echo "to start the sphinx-web server."
57+
@echo "Build finished; now you can process the pickle files."
4158

42-
web: pickle
59+
json:
60+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61+
@echo
62+
@echo "Build finished; now you can process the JSON files."
4363

4464
htmlhelp:
45-
mkdir -p _build/htmlhelp _build/doctrees
46-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
65+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
4766
@echo
4867
@echo "Build finished; now you can run HTML Help Workshop with the" \
49-
".hhp project file in _build/htmlhelp."
68+
".hhp project file in $(BUILDDIR)/htmlhelp."
69+
70+
qthelp:
71+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72+
@echo
73+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django.qhcp"
76+
@echo "To view the help file:"
77+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django.qhc"
78+
79+
devhelp:
80+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81+
@echo
82+
@echo "Build finished."
83+
@echo "To view the help file:"
84+
@echo "# mkdir -p $$HOME/.local/share/devhelp/django"
85+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django"
86+
@echo "# devhelp"
87+
88+
epub:
89+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90+
@echo
91+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
5092

5193
latex:
52-
mkdir -p _build/latex _build/doctrees
53-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
94+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95+
@echo
96+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
98+
"(use \`make latexpdf' here to do that automatically)."
99+
100+
latexpdf:
101+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102+
@echo "Running LaTeX files through pdflatex..."
103+
make -C $(BUILDDIR)/latex all-pdf
104+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105+
106+
text:
107+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108+
@echo
109+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
110+
111+
man:
112+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
54113
@echo
55-
@echo "Build finished; the LaTeX files are in _build/latex."
56-
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
57-
"run these through (pdf)latex."
114+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
58115

59116
changes:
60-
mkdir -p _build/changes _build/doctrees
61-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
117+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
62118
@echo
63-
@echo "The overview file is in _build/changes."
119+
@echo "The overview file is in $(BUILDDIR)/changes."
64120

65121
linkcheck:
66-
mkdir -p _build/linkcheck _build/doctrees
67-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
122+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
68123
@echo
69124
@echo "Link check complete; look for any errors in the above output " \
70-
"or in _build/linkcheck/output.txt."
125+
"or in $(BUILDDIR)/linkcheck/output.txt."
126+
127+
doctest:
128+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129+
@echo "Testing of doctests in the sources finished, look at the " \
130+
"results in $(BUILDDIR)/doctest/output.txt."

‎_templates/genindex.html renamed to ‎_theme/djangodocs/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% extends "!genindex.html" %}
1+
{% extends "basic/genindex.html" %}
22

33
{% block bodyclass %}{% endblock %}
44
{% block sidebarwrapper %}{% endblock %}

‎_templates/layout.html renamed to ‎_theme/djangodocs/layout.html

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% extends "!layout.html" %}
1+
{% extends "basic/layout.html" %}
22

33
{%- macro secondnav() %}
44
{%- if prev %}
@@ -16,6 +16,43 @@
1616
{%- endif %}
1717
{%- endmacro %}
1818

19+
{% block extrahead %}
20+
{{ super() }}
21+
<script type="text/javascript" src="{{ pathto('templatebuiltins.js', 1) }}"></script>
22+
<script type="text/javascript">
23+
(function($) {
24+
if (!django_template_builtins) {
25+
// templatebuiltins.js missing, do nothing.
26+
return;
27+
}
28+
$(document).ready(function() {
29+
// Hyperlink Django template tags and filters
30+
var base = "{{ pathto('ref/templates/builtins') }}";
31+
if (base == "#") {
32+
// Special case for builtins.html itself
33+
base = "";
34+
}
35+
// Tags are keywords, class '.k'
36+
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
37+
var tagname = $(elem).text();
38+
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
39+
var fragment = tagname.replace(/_/, '-');
40+
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
41+
}
42+
});
43+
// Filters are functions, class '.nf'
44+
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
45+
var filtername = $(elem).text();
46+
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
47+
var fragment = filtername.replace(/_/, '-');
48+
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
49+
}
50+
});
51+
});
52+
})(jQuery);
53+
</script>
54+
{% endblock %}
55+
1956
{% block document %}
2057
<div id="custom-doc" class="{% block bodyclass %}{{ 'yui-t6' if pagename != 'index' else '' }}{% endblock %}">
2158
<div id="hd">
@@ -24,7 +61,7 @@ <h1><a href="{{ pathto('index') }}">{{ docstitle }}</a></h1>
2461
<a title="Home page" href="{{ pathto('index') }}">ホーム</a> {{ reldelim2 }}
2562
<a title="Table of contents" href="{{ pathto('contents') }}">目次</a> {{ reldelim2 }}
2663
<a title="Global index" href="{{ pathto('genindex') }}">索引</a> {{ reldelim2 }}
27-
<a title="Search" href="{{ pathto('modindex') }}">モジュール一覧</a>
64+
<a title="Module index" href="{{ pathto('py-modindex') }}">モジュール一覧</a>
2865
</div>
2966
<div class="nav">{{ secondnav() }}</div>
3067
</div>

‎_templates/modindex.html renamed to ‎_theme/djangodocs/modindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
{% extends "!modindex.html" %}
1+
{% extends "basic/modindex.html" %}
22
{% block bodyclass %}{% endblock %}
33
{% block sidebarwrapper %}{% endblock %}

‎_templates/search.html renamed to ‎_theme/djangodocs/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
{% extends "!search.html" %}
1+
{% extends "basic/search.html" %}
22
{% block bodyclass %}{% endblock %}
33
{% block sidebarwrapper %}{% endblock %}

‎_static/default.css renamed to ‎_theme/djangodocs/static/default.css

File renamed without changes.

‎_static/djangodocs.css renamed to ‎_theme/djangodocs/static/djangodocs.css

File renamed without changes.

‎_static/docicons-behindscenes.png renamed to ‎_theme/djangodocs/static/docicons-behindscenes.png

File renamed without changes.

‎_static/docicons-note.png renamed to ‎_theme/djangodocs/static/docicons-note.png

File renamed without changes.

‎_static/docicons-philosophy.png renamed to ‎_theme/djangodocs/static/docicons-philosophy.png

File renamed without changes.

‎_static/homepage.css renamed to ‎_theme/djangodocs/static/homepage.css

File renamed without changes.

‎_static/reset-fonts-grids.css renamed to ‎_theme/djangodocs/static/reset-fonts-grids.css

File renamed without changes.

‎_theme/djangodocs/theme.conf

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[theme]
2+
inherit = basic
3+
stylesheet = default.css
4+
pygments_style = trac

0 commit comments

Comments
 (0)