SUMIN/HuggingFace_transformer
1
0
Fork 0
Code Issues Pull Requests Actions 7 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 Chaumond
2019-09-26 18:19:51 -04:00
parent ecfddc6034
commit fc9faa8a47
4 changed files with 37 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
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:

2
docs/requirements.txt
View File

@@ -29,4 +29,4 @@ urllib3==1.25.3
sphinx-markdown-tables==0.0.9
numpy==1.17.2
tensorflow==2.0.0rc2
torch==1.1.0
torch==1.2.0

41
docs/source/_static/js/custom.js
View File

File diff suppressed because one or more lines are too long

1
docs/source/examples.md Symbolic link
View File

@@ -0,0 +1 @@
../../examples/README.md