forked from collective/Collective
/
how_to_update_this_documentation.html
178 lines (163 loc) · 7.28 KB
/
how_to_update_this_documentation.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
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
<!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>How to update this page — collective.github.com - Last updated: Aug 08, 2012</title>
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: 'Last updated: Aug 08, 2012',
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="search" type="application/opensearchdescription+xml"
title="Search within collective.github.com - Last updated: Aug 08, 2012"
href="_static/opensearch.xml"/>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="collective.github.com - Last updated: Aug 08, 2012" href="index.html" />
<link rel="next" title="New to git?" href="new_to_git.html" />
<link rel="prev" title="How to follow commits" href="how_to_followcommits.html" />
<script src="_static/jquery.min.js" type="text/javascript"></script>
<script src="_static/jquery.zrssfeed.min.js" type="text/javascript"></script>
</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="new_to_git.html" title="New to git?"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="how_to_followcommits.html" title="How to follow commits"
accesskey="P">previous</a> |</li>
<li><a href="index.html">collective.github.com - Last updated: Aug 08, 2012</a> »</li>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<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>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="how_to_followcommits.html">How to follow commits</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">How to update this page</a></li>
<li class="toctree-l1"><a class="reference internal" href="new_to_git.html">New to git?</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_merge.html">How to merge pull requests (Admin documentation)</a></li>
</ul>
</div>
</div>
<script type="text/javascript">
$(document).ready(function () {
$('#zrssfeed-collective').rssfeed('https://github.com/collective.atom', {
limit: 5
});
});
</script>
<div id="zrssfeed-collective"></div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="how-to-update-this-page">
<h1>How to update this page<a class="headerlink" href="#how-to-update-this-page" title="Permalink to this headline">¶</a></h1>
<p>This page is created using Sphinx. In order to update it I would advise you
to head to <a class="reference external" href="http://sphinx.pocoo.org">http://sphinx.pocoo.org</a> and get familiar with Sphinx and
reStructeredText.</p>
<ol class="arabic simple">
<li>Clone <a class="reference external" href="http://github.com/collective">collective.github.com</a> repository</li>
</ol>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> git clone git@github.com:collective/collective.github.com
</pre></div>
</div>
<ol class="arabic simple" start="2">
<li>Run buildout</li>
</ol>
<p>Source is located in <tt class="docutils literal"><span class="pre">src</span></tt> directory.</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> <span class="nb">cd </span>src
<span class="go">src/ $ virtualenv --no-site-packages .</span>
<span class="go">src/ $ source bin/activate</span>
<span class="go">src/ $ pip install Sphinx</span>
<span class="go">src/ $ source bin/activate</span>
</pre></div>
</div>
<p>This will install all needed. Now its time for you to edit <tt class="docutils literal"><span class="pre">.rst</span></tt> files.</p>
<ol class="arabic simple" start="3">
<li>Generate html</li>
</ol>
<p>After editing <tt class="docutils literal"><span class="pre">.rst</span></tt> files you need to “compile” html.</p>
<p><strong>IMPORTANT</strong>
Make sure site looks nice when rendered. It will be compiled in root of
package.</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">src/ $ make html</span>
</pre></div>
</div>
<ol class="arabic simple" start="4">
<li>Commit changes</li>
</ol>
<p>For nice history please commit changes to <tt class="docutils literal"><span class="pre">.rst</span></tt> files separately then
changes to compiled site.</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">src/ $ git commit -a -m "Some very important changes"</span>
<span class="go">src/ $ cd ..</span>
<span class="gp">$</span> git commit -a -m <span class="s2">"Upload up html"</span>
</pre></div>
</div>
<ol class="arabic simple" start="5">
<li>Don’t forget to push</li>
</ol>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> git push origin master
</pre></div>
</div>
<p>And that’s all folks...</p>
</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="new_to_git.html" title="New to git?"
>next</a> |</li>
<li class="right" >
<a href="how_to_followcommits.html" title="How to follow commits"
>previous</a> |</li>
<li><a href="index.html">collective.github.com - Last updated: Aug 08, 2012</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Rok Garbas <rok@garbas.si>.
Last updated on Aug 08, 2012.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>