You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/11/30 17:43:54 UTC

[GitHub] aaronmarkham opened a new pull request #13488: Docs & website sphinx errors squished 🌦

aaronmarkham opened a new pull request #13488: Docs & website sphinx errors squished 🌦 
URL: https://github.com/apache/incubator-mxnet/pull/13488
 
 
   ## Description ##
   This PR fixes some of the remaining Sphinx errors and warnings coming out the Python/website part of docs generation. It fixes some Scala-related docs errors too.
    
   🐞  [get_constant ambiguous reference](http://34.201.8.176/versions/scala_docs_errors/api/python/gluon/gluon.html#mxnet.gluon.ParameterDict.get_constant) - fixed this Sphinx error; interesting note that text right after the `Returns` line is expected to be an entity so you have to make sure the reference is good and unambiguous.
   🐞  Scala docs used interpreter examples, but the current jar doesn't work with the interpreter, so I removed this notion from the [index](http://34.201.8.176/versions/scala_docs_errors/api/scala/index.html), [ndarray](http://34.201.8.176/versions/scala_docs_errors/api/scala/ndarray.html), [kvstore](http://34.201.8.176/versions/scala_docs_errors/api/scala/kvstore.html), and [symbol](http://34.201.8.176/versions/scala_docs_errors/api/scala/symbol.html) pages. `kvstore` and `ndarray` also had Sphinx errors, which are fixed now.
   🐞  The [gluon index](http://34.201.8.176/versions/scala_docs_errors/gluon/index.html) page had parsing errors. I think it is because the python code on that page isn't really functional and Sphinx was running it and failing. So I removed the python declarations. A gluon expert should really take a look and see what that page needs as far as an update with the latest/greatest info...
   🐞  [ubuntu setup](http://34.201.8.176/versions/scala_docs_errors/install/ubuntu_setup.html) - I already updated the pip package graphic, so this old table was not needed... and it was causing a Sphinx warning, so I removed it.
   🐞  [r tutorial fix](http://34.201.8.176/versions/scala_docs_errors/tutorials/r/fiveMinutesNeuralNetwork.html) - this had `{r}` on one of the code blocks... Sphinx/Pygments didn't like it, so I removed the braces.
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services