Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'master' of github.com:pmclanahan/scrumbugz

  • Loading branch information...
commit e4a584db703d7ae8421abdc36467c0860c2265c4 2 parents 61d7ad7 + a56068e
@pmclanahan authored
View
153 docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.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 <target>' where <target> 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/Scrumbugz.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Scrumbugz.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/Scrumbugz"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Scrumbugz"
+ @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."
View
242 docs/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# Scrumbugz documentation build configuration file, created by
+# sphinx-quickstart on Sat Jun 2 13:36:52 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Scrumbugz'
+copyright = u'2012, Mozilla Foundation and contributors'
+
+# 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 = 'git master'
+# The full version, including alpha/beta/rc tags.
+release = 'git master'
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# 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 = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = 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, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Scrumbugzdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Scrumbugz.tex', u'Scrumbugz Documentation',
+ u'Mozilla Foundation and contributors', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'scrumbugz', u'Scrumbugz Documentation',
+ [u'Mozilla Foundation and contributors'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'Scrumbugz', u'Scrumbugz Documentation',
+ u'Mozilla Foundation and contributors', 'Scrumbugz', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
View
12 docs/conventions.rst
@@ -0,0 +1,12 @@
+=============
+ Conventions
+=============
+
+We follow the code conventions listed in the `coding conventions page
+of the webdev bootcamp guide
+<http://mozweb.readthedocs.org/en/latest/coding.html>`_. This covers
+HTML, CSS, JS and Python.
+
+We use git and follow the conventions listed in the `git and github
+conventions page of the webdev bootcamp guide
+<http://mozweb.readthedocs.org/en/latest/git.html#working-on-projects>`_.
View
26 docs/documentation.rst
@@ -0,0 +1,26 @@
+===============
+ Documentation
+===============
+
+Conventions
+===========
+
+See the `docmentation page in the webdev bootcamp guide
+<http://mozweb.readthedocs.org/en/latest/documentation.html>`_ for
+documentation conventions.
+
+The documentation is available in HTML and PDF forms at
+`<http://scrumbugz.readthedocs.org/>`_. This tracks documentation in
+the master branch of the git repository. Because of this, it is always
+up to date.
+
+
+Building the docs
+=================
+
+The documentation in `docs/` is built with `Sphinx
+<http://sphinx.pocoo.org/>`_. To build HTML version of the
+documentation, do::
+
+ cd docs/
+ make html
View
109 docs/hacking_howto.rst
@@ -0,0 +1,109 @@
+.. _hacking-howto-chapter:
+
+===============
+ Hacking HOWTO
+===============
+
+Summary
+=======
+
+This covers setting up a development environment for Scrumbugz. If
+you're interested in running Scrumbugz, then you should checkout
+:ref:`installing-chapter`.
+
+
+Setup for development
+=====================
+
+Requirements
+------------
+
+* Bugzilla 4
+* a recent version of the Bugzilla API
+
+Currently, Scrumbugz uses Bugzilla search urls to define a sprint. It
+converts the parameters in the search url to a form which it then uses
+with the Bugzilla API.
+
+Thus, in order to use Scrumbugz, you need a Bugzilla instance that's
+running a recent version of Bugzilla and the Bugzilla API. We think
+the minimum version is Bugzilla 4, but haven't verified this.
+
+.. Note::
+
+ You don't need to install Bugzilla on your machine. As long as you
+ have access to a Bugzilla server, you're fine.
+
+
+Get dependencies
+----------------
+
+Run::
+
+ virtualenv ./venv/
+ . ./venv/bin/activate
+ pip install -r requirements-dev.txt
+
+That sets up all the dependencies required.
+
+.. Note::
+
+ You don't have to put your virtual environment in ``./venv/``. Feel
+ free to put it anywhere.
+
+
+Configure
+---------
+
+Then you should create a local file. First, copy the template over::
+
+ cp settings/local.py-dist settings/local.py
+
+and edit it.
+
+
+Set up the db
+-------------
+
+Run::
+
+ ./manage.py syncdb
+
+This also creates a superuser which you can use to log into the admin.
+
+
+Set up Cache
+------------
+
+By default the `settings/local.py` file is set up for a local memory
+cache. This should be fine for local testing and you shouldn't need
+to do anything else. If you'd like to more closely mimic production,
+you can install `memcached` or `Redis` and configure the `CACHES`
+setting in `settings/local.py` accordingly.
+
+
+Run it
+------
+
+ ./manage.py runserver
+
+Static media will be handled automatically by Django 1.3's built-in
+handler.
+
+
+Setting up a project
+====================
+
+1. Pull up the home page which should now be at `<http://localhost:8000/>`_.
+2. Click the `Admin` link on the right of the nav bar.
+3. Login with the admin account you setup in during `syncdb`,
+4. then go back to the home page.
+
+Once you're logged in you'll see buttons for creating and editing
+projects and sprints.
+
+The Bugzilla url for a sprint should be the url for a query defining
+the sprint. For example, SUMO uses the target to define sprints, so
+the query url for our 2012.6 sprint is::
+
+ https://bugzilla.mozilla.org/buglist.cgi?quicksearch=ALL%20product%3Asupport%20milestone%3A2012.6
View
40 docs/index.rst
@@ -0,0 +1,40 @@
+===========
+ Scrumbugz
+===========
+
+About Scrumbugz
+===============
+
+This is the software that runs `<https://scrumbu.gs/>`_.
+
+This allows you to manage sprints backed by Bugzilla bug data.
+
+
+Site Administrator's Guide
+==========================
+
+.. toctree::
+ :maxdepth: 1
+
+ installing
+
+
+Contributor's Guide
+===================
+
+.. toctree::
+ :maxdepth: 1
+
+ join
+ hacking_howto
+ conventions
+ documentation
+ tests
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
View
9 docs/installing.rst
@@ -0,0 +1,9 @@
+.. _installing-chapter:
+
+======================
+ Installing Scrumbugz
+======================
+
+TODO: Write this.
+
+For now, follow the :ref:`hacking-howto-chapter`.
View
46 docs/join.rst
@@ -0,0 +1,46 @@
+====================
+ Join this project!
+====================
+
+Interested in building a scrummy Bugzilla? Interested in running one?
+Then you should be interested in this project!
+
+
+Project details
+===============
+
+Code:
+ https://github.com/pmclanahan/scrumbugz
+
+Issues:
+ https://github.com/pmclanahan/scrumbugz/issues
+
+Documentation:
+ http://scrumbugz.readthedocs.org/
+
+IRC:
+ #scrum on irc.mozilla.org
+
+
+Want to help?
+=============
+
+Here are things we need help with:
+
+* **fixing bugs listed in the issue tracker**
+
+* **writing tests**
+
+* **writing documentation**: We could use help writing deployment
+ documentation for deploying Scrumbugz in other environments.
+
+* **spreading the word**: Do you know other people who would like this
+ software? If so, tell them about Scrumbugz!
+
+* **project infrastructure**: Is there infrastructure that's missing
+ in this project that would make it easier for you to collaborate? If
+ so, what?
+
+
+Are you thinking, "That's a daunting list!" That's ok! Hop on IRC, say
+hi and we can go from there!
View
18 docs/tests.rst
@@ -0,0 +1,18 @@
+=======
+ Tests
+=======
+
+Running the tests
+=================
+
+To run the tests, do::
+
+ ./manage.py test
+
+
+Writing tests
+=============
+
+Tests are located in `scrumb/tests.py`.
+
+They follow Django test conventions.
View
1  requirements-dev.txt
@@ -3,3 +3,4 @@
nose==1.1.2
mock==0.8.0
+Sphinx
Please sign in to comment.
Something went wrong with that request. Please try again.