Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
I
iot-lab-manual
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Abhas Abhinav
iot-lab-manual
Commits
b32f00ce
Commit
b32f00ce
authored
Nov 21, 2017
by
Abhas Abhinav
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add a page inside the documentation about how to build
parent
0709ecb4
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
50 additions
and
0 deletions
+50
-0
building.md
docs/building.md
+49
-0
mkdocs.yml
mkdocs.yml
+1
-0
No files found.
docs/building.md
0 → 100644
View file @
b32f00ce
# Building this documentation
## 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
`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
```
mkdocs.yml
View file @
b32f00ce
...
...
@@ -4,6 +4,7 @@ repo_url: 'https://gitlab.com/abhas/iot-lab-manual'
pages
:
-
Home
:
index.md
-
About
:
about.md
-
Building the Documentation
:
building.md
-
Conventions in this manual
:
conventions.md
-
Overview of the IoT Kit
:
overview.md
-
Safeguards and Basics
:
safeguards.md
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment