Commit 80848206 authored by Abhas Abhinav's avatar Abhas Abhinav

Added installation instructions for mkdocs

parent 3c06d6e0
......@@ -10,3 +10,52 @@ Please do read this manual carefully. It is good to familiarise yourself
with the contents of your IoT kit along with the corresponding
safeguards before you venture out to use it.
## Using this repository
This repository contains the source code for the IoT Lab manual. Here are
instructions on how to develop or test or use the documentation locally on your
own computer.
### Install Python and `python-pip`
The `mkdocs` system is built on Python. To build the documentation or browse it
locally, you need to have python install on your system. Additionally, you need
`python-pip` to install Python packages.
### Install `mkdocs` and related plugins
Once you have both Python and `python-pip` installed, you can install mkdocs
using the following commands. Additionaly, we use the `material` theme for
mkdocs. Running the following command installs both mkdocs as well as the
corresponding theme:
``` bash
$ pip install mkdocs-material
```
You can more details about this on the mkdocs-material home page:
https://squidfunk.github.io/mkdocs-material/
### Run a local webserver
You compile the documentation from the source code as follows:
``` bash
mkdocs build
```
This will generate the static HTML documentation into the `#bash site/`
directory.
You can also view the documentation using the in-built webserver by running the
following cammdn:
``` bash
$ mkdocs serve
INFO - Cleaning site directory
[I 171121 15:24:50 server:283] Serving on http://127.0.0.1:8000
[I 171121 15:24:50 handlers:60] Start watching changes
[I 171121 15:24:50 handlers:62] Start detecting changes
```
......@@ -4,7 +4,7 @@
<url>
<loc>/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -12,7 +12,7 @@
<url>
<loc>/about/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -20,7 +20,7 @@
<url>
<loc>/conventions/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -28,7 +28,7 @@
<url>
<loc>/overview/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -36,7 +36,7 @@
<url>
<loc>/safeguards/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -44,7 +44,7 @@
<url>
<loc>/getting_started/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -53,31 +53,31 @@
<url>
<loc>/common_components/breadboards/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/common_components/jumper_wires/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/common_components/soldering_irons/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/common_components/wire_strippers/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/common_components/multimeter/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -87,31 +87,31 @@
<url>
<loc>/power_supplies/breadboard/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/power_supplies/usb/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/power_supplies/12v/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/power_supplies/power_strip/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/power_supplies/lipo/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -121,91 +121,91 @@
<url>
<loc>/sensors/pulse/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/water_sensor/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/current/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/current_noninvasive/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/analog_temperature/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/digital_temperature/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/humidity/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/led/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/rgb_led/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/switch/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/hall_effect/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/reed/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/relay/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/photo_resistor/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sensors/joystick/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -215,31 +215,31 @@
<url>
<loc>/microcontrollers/arduino_mega/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/microcontrollers/arduino_pro_micro/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/microcontrollers/digispark/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/microcontrollers/nodemcu/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/microcontrollers/wemos_d1/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -249,31 +249,31 @@
<url>
<loc>/single_board_computers/raspberry_pi_3/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/single_board_computers/raspberry_pi_zero/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/single_board_computers/onion_omega2/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/single_board_computers/orange_pi_2g_iot/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/single_board_computers/nano_pi_neo_air/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -283,25 +283,25 @@
<url>
<loc>/displays/rgb_leds/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/displays/oled/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/displays/orangepi/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/displays/lcds/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -311,7 +311,7 @@
<url>
<loc>/specialised_boards/healthypi/</loc>
<lastmod>2017-11-06</lastmod>
<lastmod>2017-11-21</lastmod>
<changefreq>daily</changefreq>
</url>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment