docs/index.rst @ 9030dc9517cf

web: add basic tests

This patch adds a new test module `test_web` to automate testing of web
requests. For now the tests are rather simple and only check for
expected status codes.

To set up the flask app within the tests, it has to be configured
properly. This is the reason why the app configuration part in `web.py`
has been moved into an own function - now it may also be used by the
test module.
author Oben Sonne <obensonne@googlemail.com>
date Mon, 02 Jul 2012 22:32:48 +0200
parents 53aadb5be2b6
children (none)
.. hg-review documentation master file, created by
   sphinx-quickstart on Mon Jun 14 20:39:45 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

hg-review documentation
=======================

hg-review is a `Mercurial <http://hg-scm.org>`_ extension for performing
distributed `code review <http://en.wikipedia.org/wiki/Code_review>`_.

"Distributed code review" means you can do cool stuff like this:

.. image:: /_static/overview.png
   :alt: hg-review overview diagram
   :align: center


Quickstart
----------

If you're impatient and want to play with hg-review right away, here's what you
need to do.

First, clone the extension somewhere::

    hg clone http://bitbucket.org/sjl/hg-review/

Then add it to your ``~/.hgrc`` file::

    [extensions]
    review = [path to]/hg-review/review/

Now you need a repository that has code review enabled.  Luckily, you've
already got one -- hg-review uses itself for code review. 

``cd`` into the directory you cloned hg-review to and start the web interface::

    cd hg-review
    hg review --web

Open http://localhost:8080/ in your browser of choice and poke around. Check
out the :doc:`Overview </overview>` when you're ready to learn more.

User's Guide
------------

If you want to use hg-review for anything more than some simple poking around,
this is the place to start.

.. toctree::
   :maxdepth: 2

   overview
   concepts
   webui
   cli

Developer's Guide
-----------------

If you want to integrate hg-review with your own application or Mercurial
extension, or hack on hg-review itself, this is what you need to know.

.. toctree::
   :maxdepth: 2

   api
   hacking
   licensing