TabbycatDebate/tabbycat

View on GitHub
docs/index.rst

Summary

Maintainability
Test Coverage

.. raw:: html

    <img id="logo" src="https://raw.githubusercontent.com/TabbycatDebate/tabbycat/develop/tabbycat/static/logo.svg?sanitize=true">

======================
Tabbycat User Guide
======================

Tabbycat is a draw tabulation system for parliamentary debate tournaments. It
supports two-team formats such as Australs, World Schools, Asians, Australian
Easters and all New Zealand formats, as well as British Parliamentary (WUDC). It
is also highly configurable, supporting many custom variations of the above
formats too. If you're looking for a general overview of the software, check out our `README on Github <https://github.com/TabbycatDebate/tabbycat>`_.

.. _installation-docs:

.. toctree::
   :maxdepth: 1
   :caption: Installation

   install/heroku
   install/local
   install/docker
   install/linux
   install/osx
   install/wsl
   install/windows

.. _usage-docs:

.. toctree::
   :maxdepth: 1
   :caption: Using Tabbycat

   use/importing-data
   use/starting-a-tournament
   use/running-a-tournament
   use/finishing-a-tournament
   use/backups

.. toctree::
   :maxdepth: 1
   :caption: Tabbing Guide

   guide/tournament-logistics
   guide/comparisons
   guide/scaling
   guide/upgrading

.. _feature-docs:

.. toctree::
   :maxdepth: 1
   :caption: Feature notes

   features/adjudicator-feedback
   features/adjudicator-allocation
   features/api
   features/breaks
   features/check-ins
   features/data-entry
   features/draw-generation
   features/draw-generation-bp
   features/preformed-panels
   features/printing
   features/notifications
   features/standings-rules
   features/team-code-names
   features/data-importers
   features/tournament-archives
   features/user-accounts
   features/venue-constraints

.. _about-docs:

.. toctree::
   :maxdepth: 1
   :caption: About

   about/support
   about/authors
   about/changelog
   about/contributing
   about/licence