TeamspeakStats/docs/api.rst

API
===

Log
---

.. automodule:: tsstats.log
  :members:

Client
------
.. autoclass:: tsstats.client.Client
  :members:

  .. automethod:: tsstats.client.Client.__init__

.. autoclass:: tsstats.client.Clients
  :members:

  .. automethod:: tsstats.client.Clients.__init__
  .. automethod:: tsstats.client.Clients.__iter__

Template
--------

.. automodule:: tsstats.template
  :members:

Config
------

.. automodule:: tsstats.config
  :members:

Exceptions
----------
.. automodule:: tsstats.exceptions
  :members:

Utils
-----

.. automodule:: tsstats.utils
  :members:
add sphinx-documentation * basic index * api-documentation for tsstats.client.Client and tsstats.client.Clients 2016-05-18 15:36:09 -04:00			`API`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`===`
add sphinx-documentation * basic index * api-documentation for tsstats.client.Client and tsstats.client.Clients 2016-05-18 15:36:09 -04:00
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00			`Log`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`---`
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00
			`.. automodule:: tsstats.log`
			`:members:`

divite api.rst into sections 2016-05-28 18:26:25 -04:00			`Client`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`------`
add sphinx-documentation * basic index * api-documentation for tsstats.client.Client and tsstats.client.Clients 2016-05-18 15:36:09 -04:00			`.. autoclass:: tsstats.client.Client`
			`:members:`

			`.. automethod:: tsstats.client.Client.__init__`

			`.. autoclass:: tsstats.client.Clients`
			`:members:`

			`.. automethod:: tsstats.client.Clients.__init__`
			`.. automethod:: tsstats.client.Clients.__iter__`
add documentation for tsstats.exceptions.* 2016-05-28 18:25:21 -04:00
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00			`Template`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`--------`
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00
			`.. automodule:: tsstats.template`
			`:members:`

			`Config`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`------`
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00
			`.. automodule:: tsstats.config`
			`:members:`

divite api.rst into sections 2016-05-28 18:26:25 -04:00			`Exceptions`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`----------`
add documentation for tsstats.exceptions.* 2016-05-28 18:25:21 -04:00			`.. automodule:: tsstats.exceptions`
			`:members:`
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00
			`Utils`
Refactor documentation * move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors 2017-04-18 17:24:30 -04:00			`-----`
add documentation to tsstats.{config,log,template,utils}.* 2016-05-30 14:23:03 -04:00
			`.. automodule:: tsstats.utils`
			`:members:`