Fix fossasia#36 added steps to build documentation and modified PSL.S…

…ENSORS.rst to generate SENSOR documentation

.gitignore

@@ -5,3 +5,4 @@ __PYCACHE__
 build
 _*
 PSL.egg-info
+.idea/

README.md

@@ -12,8 +12,7 @@ This repository hosts the python library for communicating with PSLab. This can
 * FOSSASIA is supporting development and promotion of ExpEYES project since 2014 mainly through Google Summer of Code
 * The current work is a part of my GSoC-16 project
 
-##Communication
-Chat: [Pocket Science Slack Channel](http://fossasia.slack.com/messages/pocketscience/) | [Get an Invite](http://fossasia-slack.herokuapp.com/)
+### Communication Chat: [Pocket Science Slack Channel](http://fossasia.slack.com/messages/pocketscience/) | [Get an Invite](http://fossasia-slack.herokuapp.com/)
 
 ----------------
 
@@ -22,7 +21,7 @@ Installation
 
 To install PSLab on Debian based Gnu/Linux system, the following dependencies must be installed.
 
-####Dependencies
+#### Dependencies
 
 * PyQt 4.7+, PySide, or PyQt5
 * python 2.6, 2.7, or 3.x
@@ -33,10 +32,10 @@ To install PSLab on Debian based Gnu/Linux system, the following dependencies mu
 * iPython-qtconsole           #optional
 
 
-#####Now clone both the repositories [pslab-apps](https://github.com/fossasia/pslab-apps)  and [pslab](https://github.com/fossasia/pslab).
+##### Now clone both the repositories [pslab-apps](https://github.com/fossasia/pslab-apps)  and [pslab](https://github.com/fossasia/pslab).
 
 
-#####Libraries must be installed in ~~the following~~ any order
+##### Libraries must be installed in any order
 
 1. pslab-apps
 2. pslab
@@ -45,33 +44,44 @@ To install PSLab on Debian based Gnu/Linux system, the following dependencies mu
 *If user is only interested in using PSLab as an acquisition device without a display/GUI, only one repository  [pslab](https://github.com/fossasia/pslab) needs to be installed*
 
 
-#####To install, cd into the directories
+##### To install, cd into the directories
 
-`$ cd <SOURCE_DIR>`
+    $ cd <SOURCE_DIR>
 
 and run the following (for both the repos)
 
-`$ sudo make clean`
+    $ sudo make clean
 
-`$ sudo make` 
+    $ sudo make
 
-`$ sudo make install`
+    $ sudo make install
 
 Now you are ready with the PSLab software on your machine :)
 
 For the main GUI (Control panel), you can run Experiments from the terminal.
 
-`$ Experiments`
+    $ Experiments
 
 -----------------------
 
-####Development Environment
+#### Development Environment
 
 To set up the development environment, install the packages mentioned in dependencies. For building GUI's Qt Designer is used.
 
+## Steps to build documentation
+
+First install sphinx by running following command
+
+    pip install -U Sphinx
+
+Then go to pslab/docs and run the following command
+
+    $ make html
+
 ### Blog posts related to PSLab on FOSSASIA blog 
 * [Installation of PSLab](http://blog.fossasia.org/pslab-code-repository-and-installation/)
 * [Communicating with PSLab](http://blog.fossasia.org/communicating-with-pocket-science-lab-via-usb-and-capturing-and-plotting-sine-waves/)
 * [Features and Controls of PSLab](http://blog.fossasia.org/features-and-controls-of-pocket-science-lab/)
 * [Design your own Experiments](http://blog.fossasia.org/design-your-own-experiments-with-pslab/)
 * [New Tools and Sensors for Fossasia PSLab and ExpEYES](http://blog.fossasia.org/new-tools-and-sensors-fossasia-pslab-and-expeyes/) 
+

docs/PSL.SENSORS.rst

@@ -0,0 +1,126 @@
+PSL.SENSORS package
+===================
+
+Submodules
+----------
+
+PSL.SENSORS.AD7718_class module
+-------------------------------
+
+.. automodule:: PSL.SENSORS.AD7718_class
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.AD9833 module
+-------------------------
+
+.. automodule:: PSL.SENSORS.AD9833
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.BH1750 module
+-------------------------
+
+.. automodule:: PSL.SENSORS.BH1750
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.BMP180 module
+-------------------------
+
+.. automodule:: PSL.SENSORS.BMP180
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.ComplementaryFilter module
+--------------------------------------
+
+.. automodule:: PSL.SENSORS.ComplementaryFilter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.HMC5883L module
+---------------------------
+
+.. automodule:: PSL.SENSORS.HMC5883L
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.Kalman module
+-------------------------
+
+.. automodule:: PSL.SENSORS.Kalman
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.MF522 module
+------------------------
+
+.. automodule:: PSL.SENSORS.MF522
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.MLX90614 module
+---------------------------
+
+.. automodule:: PSL.SENSORS.MLX90614
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.MPU6050 module
+--------------------------
+
+.. automodule:: PSL.SENSORS.MPU6050
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.SHT21 module
+------------------------
+
+.. automodule:: PSL.SENSORS.SHT21
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.SSD1306 module
+--------------------------
+
+.. automodule:: PSL.SENSORS.SSD1306
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.TSL2561 module
+--------------------------
+
+.. automodule:: PSL.SENSORS.TSL2561
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PSL.SENSORS.supported module
+----------------------------
+
+.. automodule:: PSL.SENSORS.supported
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: PSL.SENSORS
+    :members:
+    :undoc-members:
+    :show-inheritance: