source: stamper/docs/_build/html/install.html@ 47:c38a9fd74e17

Last change on this file since 47:c38a9fd74e17 was 42:cff2c17bc1d4, checked in by Borja Lopez <borja@…>, 10 years ago

Added initial version of the docs, covering:

  • About stamper
  • Basic installation instructions (missing install from repo or dev env setup, for example)
  • Basic usage instructions (total times, per-day details, timeline, date-based filters and more)
File size: 5.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
9 <title>Installation instructions &mdash; Stamper 0.1 documentation</title>
10
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: './',
17 VERSION: '0.1',
18 COLLAPSE_INDEX: false,
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="author" title="About these documents" href="about.html" />
27 <link rel="top" title="Stamper 0.1 documentation" href="index.html" />
28 <link rel="next" title="How to use it" href="using.html" />
29 <link rel="prev" title="About Stamper" href="about.html" />
30 </head>
31 <body>
32 <div class="related">
33 <h3>Navigation</h3>
34 <ul>
35 <li class="right" style="margin-right: 10px">
36 <a href="genindex.html" title="General Index"
37 accesskey="I">index</a></li>
38 <li class="right" >
39 <a href="using.html" title="How to use it"
40 accesskey="N">next</a> |</li>
41 <li class="right" >
42 <a href="about.html" title="About Stamper"
43 accesskey="P">previous</a> |</li>
44 <li><a href="index.html">Stamper 0.1 documentation</a> &raquo;</li>
45 </ul>
46 </div>
47
48 <div class="document">
49 <div class="documentwrapper">
50 <div class="bodywrapper">
51 <div class="body">
52
53 <div class="section" id="installation-instructions">
54<h1>Installation instructions<a class="headerlink" href="#installation-instructions" title="Permalink to this headline"></a></h1>
55<p>Installing <a class="reference external" href="https://bitbucket.org/codigo23/stamper">Stamper</a> is quite easy. If you have some experience installing
56<a class="reference external" href="http://python.org">Python</a> packages <a class="footnote-reference" href="#id3" id="id1">[1]</a>, you already know how to do it. Stamper is a standard
57<a class="reference external" href="http://python.org">Python</a> package available on <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> <a class="footnote-reference" href="#id4" id="id2">[2]</a> so just use your favourite tool
58(<a class="reference external" href="http://www.pip-installer.org/en/latest/index.html">pip</a>, <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a>, etc) to intall it:</p>
59<div class="highlight-python"><div class="highlight"><pre>pip install Stamper
60</pre></div>
61</div>
62<div class="highlight-python"><div class="highlight"><pre>easy_install Stamper
63</pre></div>
64</div>
65<table class="docutils footnote" frame="void" id="id3" rules="none">
66<colgroup><col class="label" /><col /></colgroup>
67<tbody valign="top">
68<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://docs.python.org/tutorial/modules.html#packages">http://docs.python.org/tutorial/modules.html#packages</a></td></tr>
69</tbody>
70</table>
71<table class="docutils footnote" frame="void" id="id4" rules="none">
72<colgroup><col class="label" /><col /></colgroup>
73<tbody valign="top">
74<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td><a class="reference external" href="http://pypi.python.org/pypi/stamper">http://pypi.python.org/pypi/stamper</a></td></tr>
75</tbody>
76</table>
77</div>
78
79
80 </div>
81 </div>
82 </div>
83 <div class="sphinxsidebar">
84 <div class="sphinxsidebarwrapper">
85 <h4>Previous topic</h4>
86 <p class="topless"><a href="about.html"
87 title="previous chapter">About Stamper</a></p>
88 <h4>Next topic</h4>
89 <p class="topless"><a href="using.html"
90 title="next chapter">How to use it</a></p>
91 <h3>This Page</h3>
92 <ul class="this-page-menu">
93 <li><a href="_sources/install.txt"
94 rel="nofollow">Show Source</a></li>
95 </ul>
96<div id="searchbox" style="display: none">
97 <h3>Quick search</h3>
98 <form class="search" action="search.html" method="get">
99 <input type="text" name="q" />
100 <input type="submit" value="Go" />
101 <input type="hidden" name="check_keywords" value="yes" />
102 <input type="hidden" name="area" value="default" />
103 </form>
104 <p class="searchtip" style="font-size: 90%">
105 Enter search terms or a module, class or function name.
106 </p>
107</div>
108<script type="text/javascript">$('#searchbox').show(0);</script>
109 </div>
110 </div>
111 <div class="clearer"></div>
112 </div>
113 <div class="related">
114 <h3>Navigation</h3>
115 <ul>
116 <li class="right" style="margin-right: 10px">
117 <a href="genindex.html" title="General Index"
118 >index</a></li>
119 <li class="right" >
120 <a href="using.html" title="How to use it"
121 >next</a> |</li>
122 <li class="right" >
123 <a href="about.html" title="About Stamper"
124 >previous</a> |</li>
125 <li><a href="index.html">Stamper 0.1 documentation</a> &raquo;</li>
126 </ul>
127 </div>
128 <div class="footer">
129 &copy; Copyright 2014, Fco. de Borja Lopez Rio, Oscar M. Lage.
130 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
131 </div>
132 </body>
133</html>
Note: See TracBrowser for help on using the repository browser.