c-my/transformers
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Doc tweaks

Browse Source 
Co-Authored-By: Lysandre Debut <lysandre.debut@reseau.eseo.fr>
This commit is contained in:
Julien ChaumondandLysandre Debut committed 2019-09-26 18:19:51 -04:00
1 parent ecfddc6034
commit fc9faa8a47
4 files changed
+37 -11
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/README.md
+2 -2
View File
@@ -34,11 +34,11 @@ 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
Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the following
command to generate it:
```bash
ln -s ../../examples/README.md source/examples.md
ln -s ../../examples/README.md examples.md
```
Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder: