Rearrange demos to have fewer folders #1471
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
|
Check out this pull request on You'll be able to see Jupyter notebook diff and discuss changes. Powered by ReviewNB. |
|
Code Climate has analyzed commit fbd9708 and detected 2 issues on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
Merged
timpitman
approved these changes
May 5, 2020
|
Thinking about this more; could the duplicate GCN demo just be a symlink? |
That's a good idea, but I think it won't work, because |
|
This now builds without any (new) warnings, and a link checker run against our docs works except for some external links and various links to |
kjun9
approved these changes
May 5, 2020
kieranricardo
approved these changes
May 5, 2020
kjun9
added a commit
that referenced
this pull request
May 5, 2020
huonw
added a commit
that referenced
this pull request
May 6, 2020
This fixes the remaining sphinx warnings from a local `make html`: ``` .../stellargraph/mapper/padded_graph_generator.py:docstring of stellargraph.mapper.PaddedGraphGenerator.flow:4: WARNING: Inline interpreted text or phrase reference start-string without end-string. .../stellargraph/layer/gcn_lstm.py:docstring of stellargraph.layer.FixedAdjacencyGraphConvolution.call:5: WARNING: Unexpected indentation. .../docs/demos/basics/index.txt:18: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/calibration/index.txt:14: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/connector/index.txt:7: WARNING: toctree glob pattern './*' didn't match any documents .../docs/demos/connector/neo4j/index.txt:25: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/embeddings/index.txt:64: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/ensembles/index.txt:11: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/graph-classification/index.txt:34: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/index.txt:303: WARNING: toctree glob pattern './*' didn't match any documents .../docs/demos/interpretability/index.txt:30: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/link-prediction/index.txt:69: WARNING: toctree glob pattern '*/index' didn't match any documents .../docs/demos/node-classification/gcn-node-classification.nblink:556: WARNING: image file not readable: demos/node-classification/Cora-features.png .../docs/demos/node-classification/index.txt:128: WARNING: toctree glob pattern '*/index' didn't match any documents ``` As well as an extra warning only visible on Read the Docs https://readthedocs.org/projects/stellargraph/builds/10977970/ (not sure why it doesn't appear locally): ``` WARNING: missing attribute mentioned in :members: or __all__: module stellargraph, attribute ``` There's four "categories": - Invalid syntax: in `PaddedGraphGenerator.flow`, the `s` immediately after ":class:`StellarGraph`s" causes problems; in `FixedAdjacencyGraphConvolution.call`, the indentation is confusing Sphinx - Missing file: the image of features in Cora `Cora-features.png` (used in the `gcn-node-classification` demo) was forgotten and thus disappeared in #1471, this adds it back. - Globs without any files: there's various globs in the `index.txt` that were added mechanically; the mechanical adding mean they were as generic as required, handling both subfolders (`*/index`) and adjacent notebooks (`./*`). Now that we're maintaining RtD as the main source of notebooks, we can maintain these globs by hand. - Trailing comma: the trailing comma in the `:members:` declaration causes it to be looking for the attribute after that comma (i.e. the empty string) The RtD build seems to be similarly warning-free: https://readthedocs.org/projects/stellargraph/builds/10978073/ See: #1360
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Per #1428, having many subfolders makes the docs display ugly and harder to understand.
This also renames the demos to have a consistent and globally unique filename, like
<algorithm>-<extras>-<task>. This makes it easy to find a demo when looking within a file browser (such as the left hand panel of Jupyter lab) because they're sorted by algorithm name. It also ensures that a bug report just mentioning a filename is enough to work out exactly which demo and what task they're doing.This retains an existing placeholder for the GCN node classification demo, since we've linked to that in various places as a "get started with StellarGraph" demo. An alternative would be to just rely/hope that we update all those lines (#1482). The placeholder has the same name as the original, and so there's no renamed detected for
demos/node-classification/gcn/gcn-cora-node-classification-example.ipynbtodemos/node-classification/gcn-node-classification.ipynb. However, this is just a rename, with some of the internal links updated.Docs view: https://stellargraph--1471.org.readthedocs.build/en/1471/demos/index.html#table-of-contents
See: #1428