Updated docs README to feature the examples symlink

jozhang97 · Sep 6, 2019 · e52737d · e52737d
1 parent 5e151f5
commit e52737d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -34,6 +34,13 @@ pip install recommonmark
 
 ## Building the documentation
 
+Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the followig 
+command to generate it:
+
+```bash
+ln -s ../../examples/README.md source/examples.md
+```
+
 Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:
 
 ```bash