README.md 648 Bytes
Newer Older
antoine masson's avatar
beta-2    
antoine masson committed
1
# EAWAG Survey Docs
antoine masson's avatar
antoine masson committed
2

antoine masson's avatar
test    
antoine masson committed
3
This documentation is compiled and added into `/admin/docs` in the webapp
antoine masson's avatar
antoine masson committed
4

antoine masson's avatar
beta-2    
antoine masson committed
5
## Principle
antoine masson's avatar
antoine masson committed
6

antoine masson's avatar
beta-2    
antoine masson committed
7
This documentation is generated using [Mkdocs](https://www.mkdocs.org/). It converts markdown files into a static html website
antoine masson's avatar
antoine masson committed
8

antoine masson's avatar
beta-2    
antoine masson committed
9
## Commands
antoine masson's avatar
antoine masson committed
10

antoine masson's avatar
beta-2    
antoine masson committed
11
12
13
* to preview the documentation : ```mkdocs serve```
* to build the documentation : ```mkdocs build```
* to generate the ```requirements.txt``` file :  ```pip freeze > requirements.txt```
antoine masson's avatar
antoine masson committed
14

antoine masson's avatar
beta-2    
antoine masson committed
15
## Install the necessary packages to compile the documentation
antoine masson's avatar
antoine masson committed
16

antoine masson's avatar
beta-2    
antoine masson committed
17
18
19
20
1. create a directory and go inside it
1.  ```python -m venv env```
1.  ```pip install -r requirements.txt```
1. ```source ./env/bin/activate```