# HG changeset patch
# User Sandro Knauß
# Date 1335359188 -7200
# Node ID f65edc0382cc42f95bb6f09ff149c40c76852dbe
# Parent 4841b443f1fda0422153db90eb42c62f60cb9841
prepare for release:
* diffrent web directory with all web specific content (split doc dir -> doc (data) and web (rendered data))
* update installation
diff -r 4841b443f1fd -r f65edc0382cc .hgignore
--- a/.hgignore Wed Apr 25 00:06:27 2012 +0200
+++ b/.hgignore Wed Apr 25 15:06:28 2012 +0200
@@ -19,3 +19,9 @@
doc/_build/*
twisted/plugins/dropin.cache
*.db
+*.old
+_build/
+web/dev/
+web/*.html
+web/files/*.tar.gz
+web.tar.gz
diff -r 4841b443f1fd -r f65edc0382cc Makefile
--- a/Makefile Wed Apr 25 00:06:27 2012 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,153 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = doc/_build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) doc
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) doc
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make ' where is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Iro.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Iro.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/Iro"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Iro"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-info:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILDDIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
diff -r 4841b443f1fd -r f65edc0382cc createdoc.py
--- a/createdoc.py Wed Apr 25 00:06:27 2012 +0200
+++ b/createdoc.py Wed Apr 25 15:06:28 2012 +0200
@@ -5,7 +5,13 @@
from genshi import Markup
loader = TemplateLoader('doc/tmpl', auto_reload=True)
+
+from glob import glob
+import re
+import os.path
import inspect
+from pkg_resources import parse_version
+
from docutils.core import publish_doctree
import docutils
@@ -13,6 +19,10 @@
from docutils import core
from docutils.writers.html4css1 import Writer,HTMLTranslator
+from iro.view.xmlrpc import TwistedInterface as Current
+from iro import __version__
+from createerm import createSchemaPlot, tables, tables_cls
+
class NoHeaderHTMLTranslator(HTMLTranslator):
def __init__(self, document):
HTMLTranslator.__init__(self,document)
@@ -38,9 +48,6 @@
return core.publish_from_doctree(d, writer=_w)
-from iro.view.xmlrpc import TwistedInterface as Current
-
-from createerm import createSchemaPlot, tables, tables_cls
class Link():
def __init__(self,name,title):
@@ -169,6 +176,11 @@
self.description = Markup(core.publish_string(cls.__doc__,writer=_w))
+class File:
+ def __init__(self,path):
+ self.version = re.search("/iro-(.*).tar.gz",path).group(1)
+ self.name = os.path.basename(path)
+
def main():
sites=[Site("index.html","Iro"),
@@ -177,11 +189,22 @@
Site("about.html","About us"),
]
+ files=[File(f) for f in glob("web/files/*tar.gz")]
+ files.sort(key=lambda a:parse_version(a.version),reverse=True)
+ code ="files/iro-%s.tar.gz"%__version__
+
current_methods = dict(inspect.getmembers(Current()))
current=[ Method(i,current_methods) for i in Current().listMethods() if i != "listMethods" ]
t = [Table(tables_cls[str(f)]) for f in tables]
- createSchemaPlot('doc/images/db-schema.svg')
+ createSchemaPlot('web/images/db-schema.svg')
+
+ gd = {"sites":sites,
+ "current":current,
+ "tables": t,
+ "code":code,
+ "files":files
+ }
for site in sites:
print("generiere %s" % site.name)
@@ -189,8 +212,8 @@
def a(s):
if s == site:
return {"class":"menu active"}
- stream = tmpl.generate(sites=sites, active=a, current=current, tables=t)
- with open('doc/'+site.name, "w") as g:
+ stream = tmpl.generate(active=a, **gd)
+ with open('web/'+site.name, "w") as g:
g.write(stream.render('html', doctype='html'))
if __name__ == '__main__':
diff -r 4841b443f1fd -r f65edc0382cc doc/about.html
--- a/doc/about.html Wed Apr 25 00:06:27 2012 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,62 +0,0 @@
-
-
-
-
-
- Iro · About us
-
-
-
-
-
-
-
-
-
-
-
-
- Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV bzw. §5 TMG sowie beauftragt mit dem Jugendschutz gemäß TMG, JMStV sowie GjSM:
- Sandro Knauß, Anschrift wie oben, iro@netzguerilla.net
-
- Iro is a non blocking server for sending a message to a bunsh of recipient. It can handle diffrent types of message typs and can be extended easially.
- It was initially written for sms backend of castorticker.de. Diffrent backends are supportes by Iro.
-
-
-
Supported Backends
-
- A backend is a provider, that actually sends the message.
-
-
-
\ No newline at end of file
diff -r 4841b443f1fd -r f65edc0382cc doc/install.rst
--- a/doc/install.rst Wed Apr 25 00:06:27 2012 +0200
+++ b/doc/install.rst Wed Apr 25 15:06:28 2012 +0200
@@ -1,7 +1,12 @@
Installation of Iro
===================
-Start with downloading the source http://BLAFOO. Install the module via ``setup.py install`` und ran ``iro-install`` afterwards, that will create a sample configuration file named ``iro.conf``. Now update the Configuration file and run ``iro-install install`` afterwards, that will create the Database and Offers for you. After that you have to ref:`adding_user`. After that you can start Iro ``twisted -ny extras/iro.tac``.
+Start with downloading the `source <../index.html#files>`_.
+Afterwards install the module via ``setup.py install`` und ran ``iro-install``. That will create a sample configuration file named ``iro.conf``.
+Update the configuration file and run ``iro-install install`` afterwards. That will create the Database and Offers for you.
+After that you have to :ref:`adding_user`.
+Now you are ready to start Iro ``twisted -ny extras/iro.tac``.
+
.. _adding_user:
diff -r 4841b443f1fd -r f65edc0382cc doc/tmpl/index.html
--- a/doc/tmpl/index.html Wed Apr 25 00:06:27 2012 +0200
+++ b/doc/tmpl/index.html Wed Apr 25 15:06:28 2012 +0200
@@ -16,7 +16,7 @@
It was initially written for sms backend of castorticker.de. Diffrent backends are supportes by Iro.
-
+
Supported Backends
A backend is a provider, that actually sends the message.
@@ -28,18 +28,38 @@
-
+
Installation
- You'll find the installtion instruction under dev/install.
+ Just download ${code} see also installtion instruction under Installing Iro.