rename doc to docs

dmlc · Mar 21, 2016 · ebfeae6 · ebfeae6
1 parent b5b6cfa
commit ebfeae6
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,10 +3,10 @@ deps
 *.pb.*
 .*
 *core*
-doc/html
-doc/xml
-doc/latex
-doc/_build
+docs/html
+docs/xml
+docs/latex
+docs/_build
 tests/test_*
 *.pyc
 *.d

diff --git a/doc/how_to.md b/doc/how_to.md
diff --git a/doc/Doxyfile → docs/Doxyfile b/doc/Doxyfile → docs/Doxyfile
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/api.md → docs/api.md b/doc/api.md → docs/api.md
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/env.md → docs/env.md b/doc/env.md → docs/env.md
diff --git a/doc/get_started.md → docs/get_started.md b/doc/get_started.md → docs/get_started.md
diff --git a/docs/how_to.md b/docs/how_to.md
@@ -0,0 +1,31 @@
+# How To
+
+## Debug
+
+
+
+
+## Use Particular Network Interface
+
+PS-Lite will
+
+## Environment Variables to Start PS-Lite
+
+To start PS-Lite,
+Each PS-Lite instance requires
+
+
+
+The variables must be set for starting
+
+- `DMLC_NUM_WORKER` : the number of workers
+- `DMLC_NUM_SERVER` : the number of servers
+- `DMLC_ROLE` : the role of the current node, can be `worker`, `server`, or `scheduler`
+- `DMLC_PS_ROOT_URI` : the ip or hostname of the scheduler node
+- `DMLC_PS_ROOT_PORT` : the port that the scheduler node is listening
+
+additional variables:
+
+- `DMLC_INTERFACE` : the network interface a node should use. in default choose
+  automatically
+- `DMLC_LOCAL` : runs in local machines, no network is needed
diff --git a/doc/index.md → docs/index.md b/doc/index.md → docs/index.md
diff --git a/doc/overview.md → docs/overview.md b/doc/overview.md → docs/overview.md
diff --git a/doc/requirements.txt → docs/requirements.txt b/doc/requirements.txt → docs/requirements.txt
diff --git a/doc/sphinx_util.py → docs/sphinx_util.py b/doc/sphinx_util.py → docs/sphinx_util.py
diff --git a/doc/tutorials.md → docs/tutorials.md b/doc/tutorials.md → docs/tutorials.md