Updated docs README to feature the examples symlink

This commit is contained in:
LysandreJik 2019-09-06 12:13:31 -04:00
parent 5e151f5e77
commit e52737d5ad

View File

@ -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