Mercurial > p > roundup > code

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/Makefile	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,75 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview over all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+
+clean:
+	-rm -rf .build/*
+
+html:
+	mkdir -p .build/html .build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+	@echo
+	@echo "Build finished. The HTML pages are in .build/html."
+
+pickle:
+	mkdir -p .build/pickle .build/doctrees
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+web: pickle
+
+json:
+	mkdir -p .build/json .build/doctrees
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) .build/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	mkdir -p .build/htmlhelp .build/doctrees
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in .build/htmlhelp."
+
+latex:
+	mkdir -p .build/latex .build/doctrees
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in .build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	mkdir -p .build/changes .build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
+	@echo
+	@echo "The overview file is in .build/changes."
+
+linkcheck:
+	mkdir -p .build/linkcheck .build/doctrees
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in .build/linkcheck/output.txt."
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/README	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,10 @@
+These are the sources of the Roundup website.
+To build them, you need Sphinx (http://sphinx.pocoo.org/).
+
+The content of the 'docs' section are mirrored in from the roundup package,
+so make sure you have created a 'docs/' directory with the right files in it
+(see 'docs.rst') from the last roundup release.
+
+Good luck !
+
+                Stefan
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/_static/style.css	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,124 @@
+/* layout*/
+body
+{
+  font-family: sans-serif, Arial, Helvetica;
+  background-color: white;
+  color: #333;
+  margin:0;
+  padding: 0 3em 0 13em;
+}
+body > .header { margin: 0 0 0 -13em;}
+body > .footer { margin: 0 0 0 -13em; clear:both;}
+body > .navigation
+{
+  margin-left: -13em;
+  width: 13em;
+  float: left;
+}
+body > .content
+{
+  width: 100%;
+  margin: 0;
+}
+body > .header > #searchbox { position: absolute; right: 1em; top: 1em;}
+
+/* style */
+
+:link { color: #bb0000; text-decoration: none;}
+:visited { color: #770000; text-decoration: none;}
+a.toc-backref { color: #000000; }
+
+.header h1 { margin-left: 1em; }
+
+body
+{
+  font-family: sans-serif, Arial, Helvetica;
+  background-color: #f5f5f5;
+  color: #333;
+}
+
+.menu { padding: 0; margin-right: 1em;}
+.menu ul
+{
+  padding: 0;
+  margin: 0;
+}
+.menu li
+{
+  margin: 5pt 0;
+}
+.menu > ul > li > *
+{
+  display: block;
+  padding: 2pt 2pt 2pt 10pt;
+  border: solid thin #dadada;
+  background-color:#ffffff;
+}
+.menu > ul > li.current > *
+{
+  background-color:#dddddd;
+}
+
+.menu ul li:first-child { margin-top:0;}
+.menu ul { list-style-type:none;}
+
+/* sub-menus are indented */
+.menu > ul > li > ul,
+.menu > ul > li.current > ul
+{
+  border:none;
+  background-color: inherit;
+}
+.menu ul ul
+{
+  margin-left: 2em;
+  font-size: smaller;
+}
+
+/* sub-menu items draw a separator */
+.menu ul ul > li
+{
+  margin: 0;
+  padding: 0;
+  border: none;
+  border-top: solid thin #dadada;
+  background-color: inherit;
+}
+.menu ul ul > li:first-child
+{
+  border-top: none;
+}
+
+.footer
+{
+  font-size: small;
+  text-align: center;
+  color: lightgrey;
+}
+
+.content
+{
+  padding: 1em;
+  border: solid thin #dadada;
+  background-color: #ffffff;
+}
+
+/* This is a little hack to inject a 'news' block into the title
+   page without having to set up a custom directive. */
+#roundup-issue-tracker .note
+{
+  float: right;
+  width: auto;
+  border: solid thin #dadada;
+  background-color:#f5f5f5;
+  padding: 1em;
+  margin: 1em;
+}
+#roundup-issue-tracker .note .admonition-title { display: none; }
+
+table
+{
+  border-collapse: collapse;
+  border-spacing: 1px;
+  background-color: #fafafa;
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/_templates/layout.html	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,103 @@
+<!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">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    {{ metatags }}
+    {%- if builder != 'htmlhelp' %}
+      {%- set titlesuffix = " &mdash; " + docstitle|e %}
+    {%- endif %}
+    <title>{{ title|striptags }}{{ titlesuffix }}</title>
+    {%- if builder == 'web' %}
+    <link rel="stylesheet" href="{{ pathto('index') }}?do=stylesheet{%
+      if in_admin_panel %}&admin=yes{% endif %}" type="text/css" />
+    {%- for link, type, title in page_links %}
+    <link rel="alternate" type="{{ type|e(true) }}" title="{{ title|e(true) }}" href="{{ link|e(true) }}" />
+    {%- endfor %}
+    {%- else %}
+    <link rel="stylesheet" href="{{ pathto('_static/style.css', 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
+    {%- endif %}
+    {%- if builder != 'htmlhelp' %}
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+          URL_ROOT:    '{{ pathto("", 1) }}',
+          VERSION:     '{{ release|e }}',
+          COLLAPSE_MODINDEX: false,
+          FILE_SUFFIX: '{{ file_suffix }}'
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+    {%- if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+    {%- endif %}
+    {%- endif %}
+{%- block linktags %}
+    {%- if hasdoc('about') %}
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
+    {%- endif %}
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
+    {%- if hasdoc('copyright') %}
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
+    {%- if parents %}
+    <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+{%- endblock %}
+{%- block extrahead %} {% endblock %}
+  </head>
+  <body>
+    <div class="header"><h1>Roundup</h1>
+      {%- if pagename != "search" %}
+        <div id="searchbox" style="display: none">
+          <form class="search" action="{{ pathto('search') }}" method="get">
+            <input type="text" name="q" size="18" />
+            <input type="submit" value="{{ _('Search') }}" />
+            <input type="hidden" name="check_keywords" value="yes" />
+            <input type="hidden" name="area" value="default" />
+          </form>
+        </div>
+        <script type="text/javascript">$('#searchbox').show(0);</script>
+      {%- endif %}
+    </div>
+    <div class="navigation">
+      <div class="menu">
+       {{ toctree }}
+      </div>
+    </div>
+    <div class="content">
+       {% block body %} {% endblock %}
+    </div>
+{%- block footer %}
+    <div class="footer">
+      <p>hosted by <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=31577&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a></p>
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+      {%- if last_updated %}
+        {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+      {%- endif %}
+      {%- if show_source and has_source and sourcename %}
+        <p class="source"><a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">{{ _('source') }}</a></p>
+      {%- endif %}
+    </div>
+{%- endblock %}
+  </body>
+</html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/code.rst	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,31 @@
+Code
+====
+
+Changelog
+----------
+
+The changelog is available `here <http://cvs.roundup-tracker.org/roundup/roundup/CHANGES.txt?view=markup&content-type=text/vnd.viewcvs-markup&revision=HEAD>`_
+
+ViewVC
+------
+
+You may browse the repository via `viewvc <http://cvs.roundup-tracker.org/roundup/>`_
+
+Read-only Access
+----------------
+
+The code can be checked out through anonymous (pserver) CVS with the following commands::
+
+  cvs -d:pserver:anonymous@cvs.roundup-tracker.org:/cvsroot/roundup login
+
+  cvs -z3 -d:pserver:anonymous@cvs.roundup-tracker.org:/cvsroot/roundup co -P modulename
+
+Read-write Access
+-----------------
+
+Developers may also make use of shared SSH keys for authentication::
+
+  export CVS_RSH=ssh
+
+  cvs -z3 -d:ext:developername@cvs.roundup-tracker.org:/cvsroot/roundup co -P modulename
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/conf.py	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,191 @@
+# -*- coding: utf-8 -*-
+#
+# Roundup documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 20 17:33:20 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#extensions = ['toctree']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'Roundup'
+copyright = u'2009, Richard Jones'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.4'
+# The full version, including alpha/beta/rc tags.
+release = '1.4'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['.build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+html_collapse_toctree = True
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+html_add_permalinks = False
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Roundupdoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [
+  ('docs/index', 'Roundup.tex', ur'Roundup Documentation',
+   ur'Richard Jones', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/contact.rst	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,16 @@
+Contact
+=======
+
+We maintain the following mailing lists:
+
+================ ========================================================================== ======================================================================================
+roundup-user     `sign up <https://lists.sourceforge.net/lists/listinfo/roundup-users>`_    `archive <https://sourceforge.net/mailarchive/forum.php?forum_name=roundup-users>`_
+roundup-devel    `sign up <https://lists.sourceforge.net/lists/listinfo/roundup-devel>`_    `archive <https://sourceforge.net/mailarchive/forum.php?forum_name=roundup-devel>`_
+roundup-checkins `sign up <https://lists.sourceforge.net/lists/listinfo/roundup-checkins>`_ `archive <https://sourceforge.net/mailarchive/forum.php?forum_name=roundup-checkins>`_
+================ ========================================================================== ======================================================================================
+
+These lists are moderated to protect them against spam.
+Please sign up if you intend to mail repeatedly.
+
+You may talk to Roundup developers directly via irc at irc://irc.oftc.net/roundup.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/contents.rst	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,29 @@
+.. Roundup documentation master file, created by sphinx-quickstart on Tue Jan 20 17:33:20 2009.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Sitemap
+=======
+
+Contents:
+
+.. directive:: bla
+
+.. toctree::
+   :maxdepth: 2
+
+   Home <index>
+   Download <http://pypi.python.org/pypi/roundup>
+   docs
+   Issues <http://issues.roundup-tracker.org>
+   contact
+   Wiki <http://wiki.roundup-tracker.org>
+   code
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/docs.rst	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,15 @@
+Docs
+====
+
+.. toctree::
+   :maxdepth: 2
+
+   docs/features
+   docs/installation
+   docs/faq
+   docs/user_guide
+   docs/customizing
+   docs/admin_guide
+   docs/upgrading
+   Design (original) <docs/design>
+   docs/developers
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/website/www/index.rst	Fri Feb 06 13:15:47 2009 +0000
@@ -0,0 +1,44 @@
+Roundup Issue Tracker
+=====================
+
+.. note::
+
+        Latest stable release: `download`_
+
+
+Roundup is a simple-to-use and -install issue-tracking system with command-line, web and e-mail interfaces.
+It is based on the winning design from Ka-Ping Yee in the Software Carpentry "Track" design competition.
+
+The current stable version of Roundup is 1.4.x which has quite a comprehensive `feature set`_. For more information
+see the `design overview`_, and all the other `documentation`_. Roundup has been deployed for:
+
+    * bug tracking and TODO list management (the classic installation)
+    * customer help desk support (with a wizard for the phone answerers, linking to networking, system and development issue trackers)
+    * issue management for IETF working groups
+    * sales lead tracking
+    * conference paper submission and double-blind referee management
+    * weblogging (well, almost :)
+
+...and so on. It's been designed with `flexibility`_ in mind - it's not just another bug tracker.
+Roundup ships with a *demo tracker* to play with - after you've unpacked the source, just run
+"python demo.py" and load up the URL it prints out!
+
+Roundup was originally released as version 0.1.1 in late August, 2001. The first `change note`_ I wrote says:
+
+    Needed a bug tracking system. Looked around. Tried to install many Perl-based systems, to no avail.
+    Got tired of waiting for Roundup to be released. Had just finished major product project, so needed
+    something different for a while. Roundup here I come...
+
+So I've been working on this thing for over seven years. Do you like Roundup?
+Want to say thanks? You can just send me a note (I always appreciate them) or better yet, `send me a gift`_ :)
+
+-- Richard Jones, project lead developer, September 2008.
+
+
+.. _`download`: http://cheeseshop.python.org/pypi/roundup
+.. _`feature set`: docs/features.html
+.. _`design overview`: docs/design.html
+.. _`documentation`: docs
+.. _`flexibility`: docs/customizing.html
+.. _`change note`: http://roundup.cvs.sourceforge.net/roundup/roundup/CHANGES.txt?revision=HEAD&view=markup
+.. _`send me a gift`: http://www.amazon.com/o/registry/J96FJCMBG774