voting/docs/index.rst

60 wiersze
1.4 KiB
ReStructuredText

.. voting documentation master file, created by
sphinx-quickstart on Sat Jan 6 19:27:38 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
voting
======
|travis| |rtd| |codecov| |pypi| |pyversions|
.. |travis| image:: https://img.shields.io/travis/crflynn/voting.svg
:target: https://travis-ci.org/crflynn/voting
.. |rtd| image:: https://img.shields.io/readthedocs/voting.svg
:target: http://voting.readthedocs.io/en/latest/
.. |codecov| image:: https://codecov.io/gh/crflynn/voting/branch/master/graphs/badge.svg
:target: https://codecov.io/gh/crflynn/voting
.. |pypi| image:: https://img.shields.io/pypi/v/voting.svg
:target: https://pypi.python.org/pypi/voting
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/voting.svg
:target: https://pypi.python.org/pypi/voting
This is a small module that provides simple functions related to measures of
disproportionality, election quotas, and electoral apportionment.
Installation
------------
The ``voting`` package is a pure Python module available in Python 2 and 3. It
can be installed using pip:
.. code-block:: shell
pip install voting
.. toctree::
:maxdepth: 2
:caption: Contents:
apportionment
diversity
proportion
quota
notes
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`