This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Docs & website sphinx errors squished 🌦 #13488
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… clears a sphinx error
|
@mxnet-label-bot add [doc, website] |
|
@aaronmarkham could you paste the links to the previews here once the CI is done? |
|
@vandanavk - each bug bullet has a link to the preview on my web server... |
vandanavk
approved these changes
Nov 30, 2018
zhaoyao73
pushed a commit
to zhaoyao73/incubator-mxnet
that referenced
this pull request
Dec 13, 2018
* fix scala ndarray docs; remove interpreter style * fix docs error in kvstore * remove interpreter format in examples * remove python indicator for these non-functioning python code blocks; clears a sphinx error * remove old table that was not being used and was triggering a sphinx error * get rid of curly braces that was causing a pygments error * fix ambiguous reference causing sphinx error * nudging file for CI
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 - fixed this Sphinx error; interesting note that text right after the
Returnsline 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, ndarray, kvstore, and symbol pages.
kvstoreandndarrayalso had Sphinx errors, which are fixed now.🐞 The gluon index 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 - 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 - this had
{r}on one of the code blocks... Sphinx/Pygments didn't like it, so I removed the braces.