Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Docs & website sphinx errors squished 🌦 #13488

Merged
indhub merged 8 commits into
apache:masterfrom
aaronmarkham:scala_docs_errors
Dec 4, 2018
Merged

Docs & website sphinx errors squished 🌦 #13488
indhub merged 8 commits into
apache:masterfrom
aaronmarkham:scala_docs_errors

Conversation

@aaronmarkham
Copy link
Copy Markdown
Contributor

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 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, ndarray, kvstore, and symbol pages. kvstore and ndarray also 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.

@aaronmarkham aaronmarkham requested a review from szha as a code owner November 30, 2018 17:43
@aaronmarkham
Copy link
Copy Markdown
Contributor Author

@mxnet-label-bot add [doc, website]

@vandanavk
Copy link
Copy Markdown
Contributor

@aaronmarkham could you paste the links to the previews here once the CI is done?

@aaronmarkham
Copy link
Copy Markdown
Contributor Author

@vandanavk - each bug bullet has a link to the preview on my web server...

@indhub indhub merged commit d60f37b into apache:master Dec 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants