-
Notifications
You must be signed in to change notification settings - Fork 185
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
Doc toc restructure proposal (minor) #238
Comments
An extension on the above idea, using Flask's approach: With flask, the TOC on the left is just level 1 entries on the page. The page includes the tocs from each of those pages with depth of 2. They call the whole collection the "User Guide," as we currently have. The benefit of this approach is that the headings are `ctrl+f``-able all from the index page, while it still keeps the left toc tidy. |
Here's what I have so far. I like this. [I removed this] Edit: non-index pages still have the full TOC. I disabled [I removed this] Edit -- back to captioned TOCs, like below: |
@sauln here's a PR readthedocs build of what the change looks like https://kepler-mapper--239.org.readthedocs.build/en/239/ |
lol after the weekend, I like the fulltoc extension again. So the only thing this PR does is shoves the tutorials and case studies under the User's Guide TOC, instead of them being their own. I'm going to merge it since it's such a small docs change now. |
@sauln I'd like to move some toc entries around on the docs, what do you think? Here's a potato screenshot of the current:
And here is sklearn's:
Following scikit-learn docs approach, I'd like to do the following with Kepler mapper docs:
So our new list on the left would be all level 1 headers (all links), and would be:
Sklearn docs have a dedicated "user guide" section that seems to have one page for each code class -- basically a similar structure as the API docs, but more exposition than would make sense in the api docstring. But we don't have enough content for that (yet).
Sklearn "tutorial" is a verbose opinionated ordered index to their "tutorials." They seem to use the index itself to make sure they have all use-case sequential steps covered. We currently just have an unordered collection of tutorials. We could at least make a guided index page.
Btw I am making a new "tutorial" on using the html vis. I plan to have a lot of gifs in it.
The text was updated successfully, but these errors were encountered: