Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
chenpangpang
transformers
Commits
e52737d5
Commit
e52737d5
authored
Sep 06, 2019
by
LysandreJik
Browse files
Updated docs README to feature the examples symlink
parent
5e151f5e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
0 deletions
+7
-0
docs/README.md
docs/README.md
+7
-0
No files found.
docs/README.md
View file @
e52737d5
...
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment