Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert demo READMEs to Sphinx index pages (#1391)
This moves us towards using Read the Docs as the main source of demos, by duplicating the indexing information from READMEs into the Sphinx docs. We've decided to move to using Read the Docs like this because: - it gives us more control over how things are shown (e.g. #1386) - the display is faster - it allows us to version properly, including with internal links to documentation of the same version as the demo I used [m2r](https://miyakogi.github.io/m2r/index.html) to convert each of our demo READMEs to a reStructuredText `index.txt` file, and then fixed them up by hand. For each index, I've gone with: ```rst Title ====== ... description with subsections etc ... Table of contents ------------------ ... full ToC listing of subfolders/demos of this index ... ``` (Where the description is empty in some cases, for directories without READMEs: #1139.) The thinking is we'll replace the README.md files with a much simplified set of information, potentially just a link to the corresponding Read the Docs. However, the READMEs are still useful as an index if someone has a copy of the demos locally in Jupyter lab. Thus, this PR also extends the `demo_table.py` script to render the demo indexing table to both a raw-HTML markdown version into `demos/README.md` and a rST `list-table` version into `docs/demos/index.txt`. This means we can still retain that demo table in an otherwise reduced/not-human-maintained `demos/README.md`. Other than extending `demo_table.py`, this tries to do the minimal work to get this working. Future work: - optimising the display of each of the tables (at the moment they scroll sideways a lot): #1418 - handling abbreviations in the main indexing table, because it doesn't seem easy to get hover text in rST: #1417 - validating links (likely covered by #1360) - updating the demos to have relative links pointing to the index files, not README.mds (likely covered by #1292 and #1360) - updating the README files to remove their content: #1419 - updating any links to the demos on GitHub to point to Read the Docs: #1420 Rendered demo landing page: https://stellargraph--1391.org.readthedocs.build/en/1391/demos/index.html See: #1298
- Loading branch information
Showing
32 changed files
with
1,524 additions
and
183 deletions.
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
Neo4j | ||
==================================== | ||
|
||
Table of contents | ||
----------------- | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
:glob: | ||
|
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
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
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
Oops, something went wrong.