ThomasDelteil opened a new pull request #10165: Add the ability to exclude 
specific lines in tutorial notebooks generated from .md
URL: https://github.com/apache/incubator-mxnet/pull/10165
 
 
   ## Description ##
   In tutorials files, sometimes we have statements like `img.plot()` that 
generates an image. For the tutorials to be entertaining, we may want to 
include an example generated image using the image tag like this:
   `![png](img_url)`. 
   
   However this means that currently, at run-time, if someone downloads the 
generated notebook, they will see twice the image. Once from execution, and 
once from the markdown line.
   
   With this PR, we introduce a way to have `.md` lines that are not included 
in the notebook, giving a better experience to our tutorials users.
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   - [ ] Changes are complete (i.e. I finished coding on this PR)
   - [ ] Code is well-documented: 
   - [ ] For new examples, README.md is added to explain the what the example 
does, the source of the dataset, expected performance on test set and reference 
to the original paper if applicable
   - [ ] To the my best knowledge, examples are either not affected by this 
change, or have been fixed to be compatible with this change
   
   ### Changes ###
   - [ ] Adding ability to hide specific lines from tutorials, tested on 
locally built version of the website
   
   ### Test ###
   
   See:
   ![screen shot 2018-03-19 at 6 41 37 
pm](https://user-images.githubusercontent.com/3716307/37631117-69fc5f70-2ba5-11e8-9323-fb0bcc8991a1.png)
   ![screen shot 2018-03-19 at 6 42 43 
pm](https://user-images.githubusercontent.com/3716307/37631118-6c31a296-2ba5-11e8-8408-a7a265181e55.png)
   
   @safrooze @aaronmarkham 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to