.. Copyright 2011, 2015, 2016, 2021 Bastien Léonard. All rights reserved.

.. Redistribution and use in source (reStructuredText) and 'compiled'
   forms (HTML, PDF, PostScript, RTF and so forth) with or without
   modification, are permitted provided that the following conditions are
   met:

.. 1. Redistributions of source code (reStructuredText) must retain
   the above copyright notice, this list of conditions and the
   following disclaimer as the first lines of this file unmodified.

.. 2. Redistributions in compiled form (converted to HTML, PDF,
   PostScript, RTF and other formats) must reproduce the above
   copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials provided
   with the distribution.

.. THIS DOCUMENTATION IS PROVIDED BY BASTIEN LÉONARD ``AS IS'' AND ANY
   EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BASTIEN LÉONARD BE LIABLE
   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
   BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


.. pySensors documentation master file, created by
   sphinx-quickstart on Sat Nov  5 02:49:13 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pySensors's documentation!
=====================================

Easily control your hardware sensors (temperature, fan speed, etc.) with a
simple Python API.

Go to the project's page to get the source, report issues and more:
https://github.com/bastienleonard/pysensors

The lm_sensors C library
------------------------

This is really a binding for the lm_sensors C library. Its
`official homepage <http://lm-sensors.org>`_ has been unavailable for a while,
but you can still find extensive information from those links:

* `Arch Linux wiki page <https://wiki.archlinux.org/title/Lm_sensors>`_
* `GitHub project <https://github.com/lm-sensors/lm-sensors>`_
* `Copy of the old homepage <https://hwmon.wiki.kernel.org/lm_sensors>`_

Contents
--------

.. toctree::
   :maxdepth: 2

   building
   reference
   implementation

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`