Skip to content

Commit fc9faa8

Browse files
julien-cLysandreJik
andcommitted
[docs] Doc tweaks
Co-Authored-By: Lysandre Debut <lysandre.debut@reseau.eseo.fr>
1 parent ecfddc6 commit fc9faa8

File tree

4 files changed

+37
-11
lines changed

4 files changed

+37
-11
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ pip install recommonmark
3434

3535
## Building the documentation
3636

37-
Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the followig
37+
Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the following
3838
command to generate it:
3939

4040
```bash
41-
ln -s ../../examples/README.md source/examples.md
41+
ln -s ../../examples/README.md examples.md
4242
```
4343

4444
Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ urllib3==1.25.3
2929
sphinx-markdown-tables==0.0.9
3030
numpy==1.17.2
3131
tensorflow==2.0.0rc2
32-
torch==1.1.0
32+
torch==1.2.0

docs/source/_static/js/custom.js

Lines changed: 33 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/source/examples.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../examples/README.md

0 commit comments

Comments
 (0)