-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathdocdoc.html
More file actions
219 lines (205 loc) · 9.79 KB
/
docdoc.html
File metadata and controls
219 lines (205 loc) · 9.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>このドキュメントについて — Ethna 2.6 documentation</title>
<link rel="stylesheet" href="_static/ethna.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="Ethna 2.6 documentation" href="index.html" />
<link rel="next" title="開発ドキュメント" href="dev.html" />
<link rel="prev" title="その他の記事" href="article.html" />
</head>
<body>
<div id="ethna-header">
<a href="index.html">
<img src="_static/logo_transpand.png" alt="Ethna" />
</a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="dev.html" title="開発ドキュメント"
accesskey="N">next</a></li>
<li class="right" >
<a href="article.html" title="その他の記事"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Ethna 2.6 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">このドキュメントについて</a><ul>
<li><a class="reference internal" href="#id2">環境</a></li>
<li><a class="reference internal" href="#id3">リポジトリ</a></li>
<li><a class="reference internal" href="#sphinx">Sphinxインストール方法</a></li>
<li><a class="reference internal" href="#id4">ドキュメントのビルド方法</a></li>
<li><a class="reference internal" href="#id5">Sphinxドキュメントの書き方</a></li>
<li><a class="reference internal" href="#id7">方針</a></li>
<li><a class="reference internal" href="#id8">ドキュメントの追加など</a></li>
<li><a class="reference internal" href="#id9">各項の簡単なルール</a><ul>
<li><a class="reference internal" href="#id10">ドキュメントの名前</a></li>
<li><a class="reference internal" href="#php">PHPコードの書き方</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id11">その他</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="article.html"
title="previous chapter">その他の記事</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="dev.html"
title="next chapter">開発ドキュメント</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/docdoc.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input 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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="id1">
<h1>このドキュメントについて<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<p>book.ethna.jp は、Ethna のドキュメントを整理するプロジェクトです。 <cite>Sphinx</cite> を使って作成されています。</p>
<div class="section" id="id2">
<h2>環境<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://sphinx.pocoo.org/">Sphinx 1.1.3</a></li>
<li><a class="reference external" href="https://github.com/nvie/gitflow">git-flow 0.4</a></li>
</ul>
</div>
<div class="section" id="id3">
<h2>リポジトリ<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://github.com/ethna/book.ethna.jp">book.ethna.jp - GitHub</a><ul>
<li>内容は、 <a class="reference external" href="http://ethna.jp/">http://ethna.jp/</a> に表示されます。</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="sphinx">
<h2>Sphinxインストール方法<a class="headerlink" href="#sphinx" title="Permalink to this headline">¶</a></h2>
<p>Macの場合</p>
<div class="highlight-python"><pre>$ sudo easy_install sphinx</pre>
</div>
<p>Linuxの場合</p>
<p>aptitude/yum で <cite>python-setuptools</cite> をインストールした後、</p>
<div class="highlight-python"><pre>$ sudo easy_install sphinx</pre>
</div>
</div>
<div class="section" id="id4">
<h2>ドキュメントのビルド方法<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
<p>簡単です。
clone したディレクトリで</p>
<div class="highlight-python"><pre>$ make html</pre>
</div>
<p>するだけです。 <tt class="docutils literal"><span class="pre">_build/html</span></tt> ディレクトリに HTML が生成されるため、HTML ファイルをブラウザで確認しましょう。</p>
</div>
<div class="section" id="id5">
<h2>Sphinxドキュメントの書き方<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://sphinx-users.jp/doc10/">Sphinxドキュメント</a></li>
</ul>
</div>
<div class="section" id="id7">
<h2>方針<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
<p>元々の <cite>http://ethna.jp/old/</cite> の内容をベースに、バージョンに沿った内容に書きなおしたりしています。</p>
<p>生成済み Sphinx ドキュメントは GitHub Pages でホスティングされており、 <cite>http://ethna.jp/doc</cite> に適用されます。</p>
</div>
<div class="section" id="id8">
<h2>ドキュメントの追加など<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
<p>ドキュメントの間違いの指摘、修正、追加などは <cite>GitHub</cite> から直接 pull request を送っていただいても構いませんし、 <a class="reference external" href="http://ml.ethna.jp/mailman/listinfo/users">ML</a> で相談していただいても構いません。Pull request を送る際は、master ブランチへ直接はコミットせず、他の名前でブランチを適当に区切ってから送ってください。</p>
<ul class="simple">
<li>参考: <a class="reference external" href="http://d.hatena.ne.jp/hnw/20110528">GitHubへpull requestする際のベストプラクティス</a></li>
</ul>
<p>ドキュメントを充実させることに協力いただけるのは大歓迎です！</p>
</div>
<div class="section" id="id9">
<h2>各項の簡単なルール<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id10">
<h3>ドキュメントの名前<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
<p>ドキュメント名前は、 ドキュメントファイル名のスラッシュをアンダースコアに変換したものを使います。</p>
<dl class="docutils">
<dt>例:</dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">install.rst</span></tt> の場合 <tt class="docutils literal"><span class="pre">..</span> <span class="pre">_install:</span></tt></li>
<li><tt class="docutils literal"><span class="pre">reference/action.rst</span></tt> の場合 <tt class="docutils literal"><span class="pre">..</span> <span class="pre">_reference_action:</span></tt></li>
</ul>
</dd>
</dl>
</div>
<div class="section" id="php">
<h3>PHPコードの書き方<a class="headerlink" href="#php" title="Permalink to this headline">¶</a></h3>
<p>PHPコードは、次のように code-block をつかうとハイライトされます</p>
<div class="highlight-python"><pre>.. code-block:: php-inline
class Sample_Action_Sample extends Sample_ActionClass
{
// ...
}</pre>
</div>
</div>
</div>
<div class="section" id="id11">
<h2>その他<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>API ドキュメントは、生成済みのものを /api 以下に配置しているだけで Sphinx とは関係ありません</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="dev.html" title="開発ドキュメント"
>next</a></li>
<li class="right" >
<a href="article.html" title="その他の記事"
>previous</a> |</li>
<li><a href="index.html">Ethna 2.6 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Ethna Project.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>