-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.html
249 lines (151 loc) · 8.77 KB
/
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
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!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>ClojureBridgeMN Documentation — ClojureBridgeMN Documentation November 4-5, 2016 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="ClojureBridgeMN Documentation November 4-5, 2016 documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></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-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> ClojureBridgeMN Documentation
</a>
<div class="version">
Saturday Nov 5 2016 @ 15:59:08 futuro
</div>
<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>
<li class="toctree-l1"><a class="reference internal" href="setup.html">Installfest</a></li>
<li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to ClojureBridge</a></li>
<li class="toctree-l1"><a class="reference internal" href="track1.html">Track 1</a></li>
<li class="toctree-l1"><a class="reference internal" href="track2.html">Track 2</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Clojure Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="community.html">Connect with the Clojure Community</a></li>
</ul>
</div>
</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">ClojureBridgeMN Documentation</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">Docs</a> »</li>
<li>ClojureBridgeMN Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="clojurebridgemn-documentation">
<h1>ClojureBridgeMN Documentation<a class="headerlink" href="#clojurebridgemn-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="view-the-documentation-online">
<h2>View the documentation online<a class="headerlink" href="#view-the-documentation-online" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference external" href="http://clojurebridge-minneapolis.github.io">http://clojurebridge-minneapolis.github.io</a></li>
</ul>
</div>
</div>
<div class="section" id="editing-the-documention">
<h2>Editing the documention<a class="headerlink" href="#editing-the-documention" title="Permalink to this headline">¶</a></h2>
<div class="section" id="install-dependencies">
<h3>Install dependencies<a class="headerlink" href="#install-dependencies" title="Permalink to this headline">¶</a></h3>
<p>For Mac and WIndows</p>
<ol class="simple">
<li>Install python, pip, and virtualenvwrapper</li>
<li>Set up a virtualenv for the project with virtualenvwrapper. I chose to call mine “installfest”</li>
<li><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></li>
</ol>
<p>For Linux (e.g. debian unstable)</p>
<ol class="simple">
<li><code class="docutils literal"><span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">python-alabaster</span> <span class="pre">python-argh</span> <span class="pre">python-babel</span> <span class="pre">python-recommonmark</span> <span class="pre">python-docutils</span> <span class="pre">python-imagesize</span> <span class="pre">python-livereload</span> <span class="pre">python-markupsafe</span> <span class="pre">python-pathtools</span> <span class="pre">python-pygments</span> <span class="pre">python-yaml</span> <span class="pre">python-recommonmark</span> <span class="pre">python-six</span> <span class="pre">python-snowballstemmer</span> <span class="pre">python-sphinx</span> <span class="pre">python-sphinx-rtd-theme</span> <span class="pre">python-tornado</span> <span class="pre">python-watchdog</span> <span class="pre">python-pip</span></code></li>
<li><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">port-for</span></code></li>
<li><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">sphinx-autobuild</span></code></li>
</ol>
</div>
<div class="section" id="develop-with-the-interactive-autobuilder">
<h3>Develop with the interactive autobuilder<a class="headerlink" href="#develop-with-the-interactive-autobuilder" title="Permalink to this headline">¶</a></h3>
<ol class="simple">
<li><code class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></code></li>
<li>Open <a class="reference external" href="http://localhost:8000/">http://localhost:8000/</a> in your favorite browser
NOTE: the built in server is serving static files from <code class="docutils literal"><span class="pre">_build/html/index.html</span></code></li>
<li>When you are done auto building simply ^C the make process</li>
</ol>
<p>This will start an autobuild process which will:</p>
<ul class="simple">
<li>detect file changes in *.rst and *.md files and will regenerate the docs</li>
<li>cause any connected browsers to auto-reload</li>
</ul>
</div>
<div class="section" id="create-the-docs-once">
<h3>Create the docs once<a class="headerlink" href="#create-the-docs-once" title="Permalink to this headline">¶</a></h3>
<p>This is useful if you do NOT want the autobuilder or built-in web server.</p>
<p>Simply run <code class="docutils literal"><span class="pre">make</span> <span class="pre">justhtml</span></code></p>
</div>
<div class="section" id="auto-publication">
<h3>Auto-publication<a class="headerlink" href="#auto-publication" title="Permalink to this headline">¶</a></h3>
<p>Once changes in this repo are pushed to master a bot will
publish the updated documentation on <a class="reference external" href="http://clojurebridge-minneapolis.github.io">http://clojurebridge-minneapolis.github.io</a></p>
</div>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016 ClojureBridgeMN volunteers.
</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:'November 4-5, 2016',
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>