Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Symlink images into docs to be visible on Read the Docs #1468

Merged
merged 3 commits into from May 5, 2020

Conversation

huonw
Copy link
Member

@huonw huonw commented May 4, 2020

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

You'll be able to see Jupyter notebook diff and discuss changes. Powered by ReviewNB.

@codeclimate
Copy link

codeclimate bot commented May 4, 2020

Code Climate has analyzed commit 901efc9 and detected 0 issues on this pull request.

View more on Code Climate.

@huonw huonw marked this pull request as ready for review May 4, 2020 09:53
Copy link
Contributor

@timpitman timpitman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still a couple of small issues, but graph classification images now showing on rtd

@@ -1146,6 +1146,15 @@
"![image.png](attachment:image.png)"
]
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

@huonw huonw May 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, unfortunately I displaying "attachment" images doesn't work on Github. It does work on nbviewer and Read the Docs (and locally) though: https://nbviewer.jupyter.org/github/stellargraph/stellargraph/blob/3e6a1356fdab02ea5e139ee457e8ce21ebacbd19/demos/ensembles/ensemble-link-prediction-example.ipynb

This is a preexisting problem, e.g. from 0.10 many months ago: https://github.com/stellargraph/stellargraph/blob/v0.10.0/demos/ensembles/ensemble-link-prediction-example.ipynb

"source": [
"## Conclusion\n",
"\n",
"In this example, we used `stellargraph`s `BaggingEnsemble` class of GraphSAGE models to predict citation links in the Cora dataset. The `BaggingEnsemble` class brings ensemble learning to `stellargraph`'s graph neural network models, e.g., `GraphSAGE`, quantifying prediction variance and potentially improving prediction accuracy. "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting here doesn't render well on rtd:

Screen Shot 2020-05-05 at 10 51 35 am

Copy link
Member Author

@huonw huonw May 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you be more specific about what you mean?

That said, I think this can be removed now after #1460, there's no longer the block quote that hit spatialaudio/nbsphinx#450, and it works again on develop: https://stellargraph.readthedocs.io/en/latest/demos/ensembles/ensemble-link-prediction-example.html (see the end)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For specifics, I meant "stellargraph" there doesn't work well with the (inconsistent) 's and s. This PR is now images only though

@huonw huonw requested a review from timpitman May 5, 2020 01:01
@huonw huonw changed the title Fix some minor Read the Docs problems Symlink images into docs to be visible on Read the Docs May 5, 2020
Copy link
Contributor

@timpitman timpitman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Images are working on rtd 👍

@huonw huonw merged commit 1af046e into develop May 5, 2020
@huonw huonw deleted the bugfix/1360-sphinx-warnings branch May 5, 2020 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants