-
Notifications
You must be signed in to change notification settings - Fork 0
/
making_of.html
235 lines (163 loc) · 9.51 KB
/
making_of.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
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Making Of — jukart's Blog</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="jukart's Blog" href="index.html"/>
<link rel="prev" title="IID Generator Using Elasticsearch" href="esiidgenerator.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
<!-- start Mixpanel --><script type="text/javascript">(function(f,b){if(!b.__SV){var a,e,i,g;window.mixpanel=b;b._i=[];b.init=function(a,e,d){function f(b,h){var a=h.split(".");2==a.length&&(b=b[a[0]],h=a[1]);b[h]=function(){b.push([h].concat(Array.prototype.slice.call(arguments,0)))}}var c=b;"undefined"!==typeof d?c=b[d]=[]:d="mixpanel";c.people=c.people||[];c.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};c.people.toString=function(){return c.toString(1)+".people (stub)"};i="disable track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config people.set people.set_once people.increment people.append people.track_charge people.clear_charges people.delete_user".split(" ");
for(g=0;g<i.length;g++)f(c,i[g]);b._i.push([a,e,d])};b.__SV=1.2;a=f.createElement("script");a.type="text/javascript";a.async=!0;a.src="//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";e=f.getElementsByTagName("script")[0];e.parentNode.insertBefore(a,e)}})(document,window.mixpanel||[]);
mixpanel.init("5bada2b895f5c876475da18567064055");</script><!-- end Mixpanel -->
<script>
mixpanel.track('making_of');
</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="index.html" class="fa fa-home"> jukart</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="esiidgenerator.html">IID Generator Using Elasticsearch</a><ul>
<li class="toctree-l2"><a class="reference internal" href="esiidgenerator.html#generator-explained-curl">Generator Explained (curl)</a></li>
<li class="toctree-l2"><a class="reference internal" href="esiidgenerator.html#optimized-for-real-world-use">Optimized for real world use</a></li>
<li class="toctree-l2"><a class="reference internal" href="esiidgenerator.html#with-python">With Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="esiidgenerator.html#references">References</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">The making of this page</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#github-repository">Github Repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="#managing-the-repository-and-deployment">Managing The Repository And Deployment</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">jukart</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="fa fa-home"> Home</a> »</li>
<li>Making Of</li>
<li class="wy-breadcrumbs-aside">
<a href="http://www.lovelysystems.com">Lovely Systems</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="making-of">
<h1>Making Of<a class="headerlink" href="#making-of" title="Permalink to this headline">¶</a></h1>
<p>This page is hosted on <a class="reference external" href="https://github.com">github</a> and built using
<a class="reference external" href="http://sphinx-doc.org">sphinx</a>.</p>
<p>Here is how I managed to build and deploy this page.</p>
<div class="section" id="github-repository">
<h2>Github Repository<a class="headerlink" href="#github-repository" title="Permalink to this headline">¶</a></h2>
<p>First you need to setup a new repository with the name <gituser>.github.io.</p>
<p>More info about github pages can be found here: <a class="reference external" href="https://pages.github.com/">https://pages.github.com/</a></p>
</div>
<div class="section" id="managing-the-repository-and-deployment">
<h2>Managing The Repository And Deployment<a class="headerlink" href="#managing-the-repository-and-deployment" title="Permalink to this headline">¶</a></h2>
<p>This was inspired by <a class="reference external" href="http://blog.nikhilism.com/2012/08/automatic-github-pages-generation-from.html">Nikhil Marathe’s blog</a></p>
<p>Building for a user-page is a little bit different than building a page for a
repository. A user-page is rendered from the <cite>master</cite> branch not from
<cite>gh-pages</cite>. So I reverted the use of the branches in the Makefile to have the
sources in the branch <cite>page</cite> and build into <cite>master</cite> branch.</p>
<p>First create a new orphan branch:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">git</span> <span class="n">checkout</span> <span class="o">--</span><span class="n">orphan</span> <span class="n">page</span>
<span class="gp">>>> </span><span class="n">git</span> <span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="o">.</span>
</pre></div>
</div>
<p>Now create the initial sphinx files:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">sphinx</span><span class="o">-</span><span class="n">quickstart</span>
</pre></div>
</div>
<p>Commit all the files.</p>
<p>Now add this to the end of your Makefile:</p>
<div class="highlight-python"><div class="highlight"><pre># All files/directories needed for deployment
PAGE_SOURCES = source Makefile
deploy:
git checkout master
rm -rf build _sources _static
git checkout page $(PAGE_SOURCES)
git reset HEAD
make html
mv -fv build/html/* ./
rm -rf $(PAGE_SOURCES) build
git add -A
git commit -m "Generated page for `git log master -1 --pretty=short --abbrev-commit`" && git push origin master ; git checkout page
</pre></div>
</div>
<p>With <cite>make deploy</cite> you are now able to completely deploy you page into
<cite>master</cite> branch:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">make</span> <span class="n">deploy</span>
</pre></div>
</div>
<div id="disqus_thread"></div>
<script type="text/javascript">
var disqus_shortname = 'jukartgithubio';
var disqus_identifier = 'making_of';
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript></div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="esiidgenerator.html" class="btn btn-neutral" title="IID Generator Using Elasticsearch"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1',
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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>