source: mailjam/docs/src/_build/html/index.html@ 13:f1f11159dbed

Last change on this file since 13:f1f11159dbed was 13:f1f11159dbed, checked in by Borja Lopez <borja@…>, 10 years ago

Added first version of the project documentation. Inside docs/src there is
the sphinx [1] project we use to manage the docs. Inside docs/html there is
a copy of the docs in html format.

Fixed some typos in the INSTALL file

Added two new parameters to the postman.conf file (both the example config
file inside conf/ and the one used for testing in postman/tests/). These
parameters do nothing yet (they are related to ssl stuff) but we do talk
about them in the docs.

Added a new method to the XMLRPC list of methods related to members.

[1] http://sphinx.pocoo.org

File size: 6.5 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
11 <title>Postman official documentation &mdash; Postman 0.1.0 documentation</title>
12
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
18 URL_ROOT: '',
19 VERSION: '0.1.0',
20 COLLAPSE_INDEX: false,
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
23 };
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <link rel="top" title="Postman 0.1.0 documentation" href="#" />
29 <link rel="next" title="Overview of postman’s architecture" href="overview.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="overview.html" title="Overview of postman’s architecture"
40 accesskey="N">next</a> |</li>
41 <li><a href="#">Postman 0.1.0 documentation</a> &raquo;</li>
42 </ul>
43 </div>
44
45 <div class="document">
46 <div class="documentwrapper">
47 <div class="bodywrapper">
48 <div class="body">
49
50 <div class="section" id="postman-official-documentation">
51<h1>Postman official documentation<a class="headerlink" href="#postman-official-documentation" title="Permalink to this headline"></a></h1>
52<p>This is the official documentation for <a class="reference external" href="https://bitbucket.org/codigo23/postman">Postman</a>, a mailing list management
53software written in <a class="reference external" href="http://python.org">Python</a>.</p>
54<p>Contents:</p>
55<div class="toctree-wrapper compound">
56<ul>
57<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of postman&#8217;s architecture</a><ul>
58<li class="toctree-l2"><a class="reference internal" href="overview.html#introduction">Introduction</a></li>
59<li class="toctree-l2"><a class="reference internal" href="overview.html#postman-daemon">Postman daemon</a></li>
60<li class="toctree-l2"><a class="reference internal" href="overview.html#mta-client">MTA client</a></li>
61<li class="toctree-l2"><a class="reference internal" href="overview.html#cli-client">CLI client</a></li>
62<li class="toctree-l2"><a class="reference internal" href="overview.html#web-client">Web client</a></li>
63</ul>
64</li>
65<li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a><ul>
66<li class="toctree-l2"><a class="reference internal" href="install.html#first-install-dependencies">First, install dependencies</a></li>
67<li class="toctree-l2"><a class="reference internal" href="install.html#second-install-postman">Second, install Postman</a></li>
68<li class="toctree-l2"><a class="reference internal" href="install.html#setting-up-postman">Setting up Postman</a></li>
69<li class="toctree-l2"><a class="reference internal" href="install.html#running-postman">Running Postman</a></li>
70<li class="toctree-l2"><a class="reference internal" href="install.html#running-tests-developers-only">Running tests (developers only)</a></li>
71</ul>
72</li>
73<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
74<li class="toctree-l2"><a class="reference internal" href="configuration.html#postman-daemon-configuration-file">Postman daemon configuration file</a></li>
75</ul>
76</li>
77<li class="toctree-l1"><a class="reference internal" href="running.html">Running Postman</a></li>
78<li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
79<li class="toctree-l1"><a class="reference internal" href="development.html">Developers documentation</a></li>
80</ul>
81</div>
82</div>
83<div class="section" id="indices-and-tables">
84<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
85<ul class="simple">
86<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
87<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
88<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
89</ul>
90</div>
91
92
93 </div>
94 </div>
95 </div>
96 <div class="sphinxsidebar">
97 <div class="sphinxsidebarwrapper">
98 <h3><a href="#">Table Of Contents</a></h3>
99 <ul>
100<li><a class="reference internal" href="#">Postman official documentation</a><ul>
101</ul>
102</li>
103<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
104</ul>
105
106 <h4>Next topic</h4>
107 <p class="topless"><a href="overview.html"
108 title="next chapter">Overview of postman&#8217;s architecture</a></p>
109 <h3>This Page</h3>
110 <ul class="this-page-menu">
111 <li><a href="_sources/index.txt"
112 rel="nofollow">Show Source</a></li>
113 </ul>
114<div id="searchbox" style="display: none">
115 <h3>Quick search</h3>
116 <form class="search" action="search.html" method="get">
117 <input type="text" name="q" />
118 <input type="submit" value="Go" />
119 <input type="hidden" name="check_keywords" value="yes" />
120 <input type="hidden" name="area" value="default" />
121 </form>
122 <p class="searchtip" style="font-size: 90%">
123 Enter search terms or a module, class or function name.
124 </p>
125</div>
126<script type="text/javascript">$('#searchbox').show(0);</script>
127 </div>
128 </div>
129 <div class="clearer"></div>
130 </div>
131 <div class="related">
132 <h3>Navigation</h3>
133 <ul>
134 <li class="right" style="margin-right: 10px">
135 <a href="genindex.html" title="General Index"
136 >index</a></li>
137 <li class="right" >
138 <a href="overview.html" title="Overview of postman’s architecture"
139 >next</a> |</li>
140 <li><a href="#">Postman 0.1.0 documentation</a> &raquo;</li>
141 </ul>
142 </div>
143 <div class="footer">
144 &copy; Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
145 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
146 </div>
147 </body>
148</html>
Note: See TracBrowser for help on using the repository browser.