Repository :
http://git.fedorahosted.org/cgit/fedocal.git
On branch : master
---------------------------------------------------------------
commit b11c3b951cd311e5677cf68144741eb9da2e3d56
Author: Pierre-Yves Chibon <pingou(a)pingoured.fr>
Date: Thu Nov 8 08:49:14 2012 +0100
Let's not keep twice the documentation
---------------------------------------------------------------
README.html | 431 -----------------------------------------------------------
1 files changed, 0 insertions(+), 431 deletions(-)
diff --git a/README.html b/README.html
deleted file mode 100644
index f44ff09..0000000
--- a/README.html
+++ /dev/null
@@ -1,431 +0,0 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!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" xml:lang="en"
lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8"
/>
-<meta name="generator" content="Docutils 0.8.1:
http://docutils.sourceforge.net/" />
-<title>fedocal</title>
-<meta name="author" content="Pierre-Yves Chibon
<pingou@pingoured.fr>" />
-<style type="text/css">
-
-/*
-:Author: David Goodger (goodger(a)python.org)
-:Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
-:Copyright: This stylesheet has been placed in the public domain.
-
-Default cascading style sheet for the HTML output of Docutils.
-
-See
http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
-customize this style sheet.
-*/
-
-/* used to remove borders from tables and images */
-.borderless, table.borderless td, table.borderless th {
- border: 0 }
-
-table.borderless td, table.borderless th {
- /* Override padding for "table.docutils td" with "! important".
- The right padding separates the table cells. */
- padding: 0 0.5em 0 0 ! important }
-
-.first {
- /* Override more specific margin styles with "! important". */
- margin-top: 0 ! important }
-
-.last, .with-subtitle {
- margin-bottom: 0 ! important }
-
-.hidden {
- display: none }
-
-a.toc-backref {
- text-decoration: none ;
- color: black }
-
-blockquote.epigraph {
- margin: 2em 5em ; }
-
-dl.docutils dd {
- margin-bottom: 0.5em }
-
-object[type="image/svg+xml"],
object[type="application/x-shockwave-flash"] {
- overflow: hidden;
-}
-
-/* Uncomment (and remove this text!) to get bold-faced definition list terms
-dl.docutils dt {
- font-weight: bold }
-*/
-
-div.abstract {
- margin: 2em 5em }
-
-div.abstract p.topic-title {
- font-weight: bold ;
- text-align: center }
-
-div.admonition, div.attention, div.caution, div.danger, div.error,
-div.hint, div.important, div.note, div.tip, div.warning {
- margin: 2em ;
- border: medium outset ;
- padding: 1em }
-
-div.admonition p.admonition-title, div.hint p.admonition-title,
-div.important p.admonition-title, div.note p.admonition-title,
-div.tip p.admonition-title {
- font-weight: bold ;
- font-family: sans-serif }
-
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title {
- color: red ;
- font-weight: bold ;
- font-family: sans-serif }
-
-/* Uncomment (and remove this text!) to get reduced vertical space in
- compound paragraphs.
-div.compound .compound-first, div.compound .compound-middle {
- margin-bottom: 0.5em }
-
-div.compound .compound-last, div.compound .compound-middle {
- margin-top: 0.5em }
-*/
-
-div.dedication {
- margin: 2em 5em ;
- text-align: center ;
- font-style: italic }
-
-div.dedication p.topic-title {
- font-weight: bold ;
- font-style: normal }
-
-div.figure {
- margin-left: 2em ;
- margin-right: 2em }
-
-div.footer, div.header {
- clear: both;
- font-size: smaller }
-
-div.line-block {
- display: block ;
- margin-top: 1em ;
- margin-bottom: 1em }
-
-div.line-block div.line-block {
- margin-top: 0 ;
- margin-bottom: 0 ;
- margin-left: 1.5em }
-
-div.sidebar {
- margin: 0 0 0.5em 1em ;
- border: medium outset ;
- padding: 1em ;
- background-color: #ffffee ;
- width: 40% ;
- float: right ;
- clear: right }
-
-div.sidebar p.rubric {
- font-family: sans-serif ;
- font-size: medium }
-
-div.system-messages {
- margin: 5em }
-
-div.system-messages h1 {
- color: red }
-
-div.system-message {
- border: medium outset ;
- padding: 1em }
-
-div.system-message p.system-message-title {
- color: red ;
- font-weight: bold }
-
-div.topic {
- margin: 2em }
-
-h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
-h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
- margin-top: 0.4em }
-
-h1.title {
- text-align: center }
-
-h2.subtitle {
- text-align: center }
-
-hr.docutils {
- width: 75% }
-
-img.align-left, .figure.align-left, object.align-left {
- clear: left ;
- float: left ;
- margin-right: 1em }
-
-img.align-right, .figure.align-right, object.align-right {
- clear: right ;
- float: right ;
- margin-left: 1em }
-
-img.align-center, .figure.align-center, object.align-center {
- display: block;
- margin-left: auto;
- margin-right: auto;
-}
-
-.align-left {
- text-align: left }
-
-.align-center {
- clear: both ;
- text-align: center }
-
-.align-right {
- text-align: right }
-
-/* reset inner alignment in figures */
-div.align-right {
- text-align: inherit }
-
-/* div.align-center * { */
-/* text-align: left } */
-
-ol.simple, ul.simple {
- margin-bottom: 1em }
-
-ol.arabic {
- list-style: decimal }
-
-ol.loweralpha {
- list-style: lower-alpha }
-
-ol.upperalpha {
- list-style: upper-alpha }
-
-ol.lowerroman {
- list-style: lower-roman }
-
-ol.upperroman {
- list-style: upper-roman }
-
-p.attribution {
- text-align: right ;
- margin-left: 50% }
-
-p.caption {
- font-style: italic }
-
-p.credits {
- font-style: italic ;
- font-size: smaller }
-
-p.label {
- white-space: nowrap }
-
-p.rubric {
- font-weight: bold ;
- font-size: larger ;
- color: maroon ;
- text-align: center }
-
-p.sidebar-title {
- font-family: sans-serif ;
- font-weight: bold ;
- font-size: larger }
-
-p.sidebar-subtitle {
- font-family: sans-serif ;
- font-weight: bold }
-
-p.topic-title {
- font-weight: bold }
-
-pre.address {
- margin-bottom: 0 ;
- margin-top: 0 ;
- font: inherit }
-
-pre.literal-block, pre.doctest-block, pre.math {
- margin-left: 2em ;
- margin-right: 2em }
-
-span.classifier {
- font-family: sans-serif ;
- font-style: oblique }
-
-span.classifier-delimiter {
- font-family: sans-serif ;
- font-weight: bold }
-
-span.interpreted {
- font-family: sans-serif }
-
-span.option {
- white-space: nowrap }
-
-span.pre {
- white-space: pre }
-
-span.problematic {
- color: red }
-
-span.section-subtitle {
- /* font-size relative to parent (h1..h6 element) */
- font-size: 80% }
-
-table.citation {
- border-left: solid 1px gray;
- margin-left: 1px }
-
-table.docinfo {
- margin: 2em 4em }
-
-table.docutils {
- margin-top: 0.5em ;
- margin-bottom: 0.5em }
-
-table.footnote {
- border-left: solid 1px black;
- margin-left: 1px }
-
-table.docutils td, table.docutils th,
-table.docinfo td, table.docinfo th {
- padding-left: 0.5em ;
- padding-right: 0.5em ;
- vertical-align: top }
-
-table.docutils th.field-name, table.docinfo th.docinfo-name {
- font-weight: bold ;
- text-align: left ;
- white-space: nowrap ;
- padding-left: 0 }
-
-h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
-h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
- font-size: 100% }
-
-ul.auto-toc {
- list-style-type: none }
-
-</style>
-</head>
-<body>
-<div class="document" id="fedocal">
-<h1 class="title">fedocal</h1>
-<table class="docinfo" frame="void" rules="none">
-<col class="docinfo-name" />
-<col class="docinfo-content" />
-<tbody valign="top">
-<tr><th class="docinfo-name">Author:</th>
-<td>Pierre-Yves Chibon <<a class="reference external"
href="mailto:pingou@pingoured.fr">pingou@pingoured.fr</a>></td></tr>
-</tbody>
-</table>
-<p>fedocal is a web based calendar application.</p>
-<div class="section" id="get-this-project">
-<h1>Get this project:</h1>
-<p>Source: <a class="reference external"
href="https://github.com/pypingou/fedocal">https://github.co...
-</div>
-<div class="section" id="dependencies">
-<h1>Dependencies:</h1>
-<p>This project is a <a class="reference external"
href="http://flask.pocoo.org/">Flask</a> application. The calendars and
meetings are
-stored into a relational database using <a class="reference external"
href="http://www.sqlalchemy.org/">SQLAlchemy</a> as Object Relational
-Mapper (ORM). fedocal provides an <a class="reference external"
href="http://en.wikipedia.org/wiki/ICalendar">iCal</a> feed for each
calendar and relies
-on <a class="reference external"
href="http://vobject.skyhouseconsulting.com/">python-vobject... for
this.</p>
-<p>The dependency list is therefore:</p>
-<ul class="simple">
-<li><a class="reference external"
href="http://www.python.org">python</a> (2.5 minimum)</li>
-<li><a class="reference external"
href="http://flask.pocoo.org/">python-flask</a></li...
-<li><a class="reference external"
href="http://packages.python.org/Flask-WTF/">python-flask-wt...
-<li><a class="reference external"
href="http://wtforms.simplecodes.com/docs/1.0.1/">python-wtf...
-<li><a class="reference external"
href="http://www.sqlalchemy.org/">python-sqlalchemy</a>...
-<li><a class="reference external"
href="http://vobject.skyhouseconsulting.com/">python-vobject...
-<li><a class="reference external"
href="http://packages.python.org/kitchen/">python-kitchen<...
-</ul>
-</div>
-<div class="section" id="running-a-development-instance">
-<h1>Running a development instance:</h1>
-<p>Clone the source:</p>
-<pre class="literal-block">
-git clone
https://github.com/pypingou/fedocal.git
-</pre>
-<p>Copy the configuration file:</p>
-<pre class="literal-block">
-cp fedocal.cfg.sample fedocal.cfg
-</pre>
-<p>Adjust the configuration file (secret key, database URL, admin
group...)</p>
-<p>Create the database scheme:</p>
-<pre class="literal-block">
-python fedocal/fedocallib/model.py
-</pre>
-<dl class="docutils">
-<dt>Run the server::</dt>
-<dd>python fedocal/__init__.py</dd>
-</dl>
-<p>You should be able to access the server at <a class="reference
external"
href="http://localhost:5000">http://localhost:5000</a></p>
-</div>
-<div class="section" id="deploying-this-project">
-<h1>Deploying this project:</h1>
-<p>Instruction to deploy this application is available on the
-<a class="reference external"
href="http://flask.pocoo.org/docs/deploying/">Flask deployment
documentation</a> page.</p>
-<blockquote>
-<strong>My approach.</strong></blockquote>
-<p>Below is the approach I took to deploy the instance on a local (test)
machine.</p>
-<p>Retrieve the sources:</p>
-<pre class="literal-block">
-cd /srv/
-git clone <repo>
-cd fedocal
-</pre>
-<p>Copy the configuration file:</p>
-<pre class="literal-block">
-cp fedocal.cfg.sample fedocal.cfg
-</pre>
-<p>Adjust the configuration file (secret key, database URL, admin
group...)</p>
-<p>Create the database scheme:</p>
-<pre class="literal-block">
-python fedocal/fedocallib/model.py
-</pre>
-<p>Then configure apache:</p>
-<pre class="literal-block">
-sudo vim /etc/httd/conf.d/wsgi.conf
-</pre>
-<p>and put in this file:</p>
-<pre class="literal-block">
-WSGIScriptAlias /fedocal /var/www/wsgi/fedocal.wsgi
-<Directory /var/www/wsgi/>
- Order deny,allow
- Allow from all
-</Directory>
-</pre>
-<p>Then create the file /var/www/wsgi/fedocal.wsgi with:</p>
-<pre class="literal-block">
-import sys
-sys.path.insert(0, '/mnt/fedocal/')
-
-import fedocal
-application = fedocal.APP
-</pre>
-<p>Then restart apache and you should be able to access the website on
-<a class="reference external"
href="http://localhost/fedocal">http://localhost/fedocal</a></p>
-</div>
-<div class="section" id="testing">
-<h1>Testing:</h1>
-<p>This project contains unit-tests allowing you to check if your server
-has all the dependencies correctly set.</p>
-<p>To run them:</p>
-<pre class="literal-block">
-./run_tests.sh
-</pre>
-</div>
-<div class="section" id="license">
-<h1>License:</h1>
-<p>This project is licensed GPLv3+.</p>
-</div>
-</div>
-</body>
-</html>