This repository has been archived by the owner on Oct 9, 2018. It is now read-only.
forked from hotsyk/python-odesk
-
Notifications
You must be signed in to change notification settings - Fork 8
/
docs_readme.html
130 lines (121 loc) · 5 KB
/
docs_readme.html
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
<!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>Generating documentation — python-odesk 0.5.6 documentation</title>
<link rel="stylesheet" href="static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.5.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="top" title="python-odesk 0.5.6 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/docs_readme.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="generating-documentation">
<h1>Generating documentation<a class="headerlink" href="#generating-documentation" title="Permalink to this headline">¶</a></h1>
<p>For documentation we use <tt class="docutils literal"><span class="pre">sphinx</span></tt>, it autogenerates the documentation into html.</p>
<p>To generate new docs do the following:</p>
<ol class="arabic">
<li><p class="first">Generate reference documetation for <tt class="docutils literal"><span class="pre">odesk</span></tt> module:</p>
<div class="highlight-python"><div class="highlight"><pre>sphinx-apidoc --force -o reference-docs odesk
</pre></div>
</div>
</li>
<li><p class="first">Edit the <tt class="docutils literal"><span class="pre">reference-docs/odesk.rst</span></tt>:</p>
<blockquote>
<div><ul class="simple">
<li>Move <tt class="docutils literal"><span class="pre">Module</span> <span class="pre">contents</span></tt> section to the top</li>
<li>Delete <tt class="docutils literal"><span class="pre">odesk.tests</span> <span class="pre">module</span></tt> section</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Edit the <tt class="docutils literal"><span class="pre">reference-docs/odesk.routers.rst</span></tt>:</p>
<ul class="simple">
<li>Move <tt class="docutils literal"><span class="pre">Module</span> <span class="pre">contents</span></tt> section to the top</li>
</ul>
</li>
<li><p class="first">Generate documentation in html format:</p>
<div class="highlight-python"><div class="highlight"><pre>sphinx-build -b html . _gh-pages
</pre></div>
</div>
</li>
<li><p class="first">Check the documentation html that everything is okay.</p>
</li>
<li><p class="first">Upload contents of <tt class="docutils literal"><span class="pre">_gh-pages</span></tt> folder to the Github Pages (see <tt class="docutils literal"><span class="pre">gh-pages</span></tt> branch):</p>
<div class="highlight-python"><div class="highlight"><pre>sh update_docs.sh
</pre></div>
</div>
</li>
</ol>
</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="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2013, odesk.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>