search

dmlc / gluon-nlp

NLP made easy
https://nlp.gluon.ai/
Apache License 2.0
2.56k stars 538 forks source link

API doc examples are currently not easy to copy/paste #162

Open szha opened 6 years ago

szha commented 6 years ago

users may want to use a snippet from example directly, so making the notebooks copy-friendly is important

currently the code blocks have python shell prefix ">>>" in them. see http://gluon-nlp.mxnet.io/api/notes/data_api.html

leezu commented 6 years ago

I suggest we follow https://devguide.python.org/documenting/#showing-code-examples (note the toggle in the upper right corner of the code example)

leezu commented 5 years ago

Reopening due to https://github.com/dmlc/gluon-nlp/pull/438

leezu commented 5 years ago

We may not need to add a copy button again. It seems reasonably simple to copy code examples without any supporting button with the new layout. If you agree, feel free to close again.

szha commented 5 years ago

@leezu let's see how the new build looks.

eric-haibin-lin commented 5 years ago

Any update on this?

szha commented 5 years ago

The problem still exists for the linked doc http://gluon-nlp.mxnet.io/api/notes/data_api.html