-
Notifications
You must be signed in to change notification settings - Fork 118
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
docs: Use MyST and sphinx-external-toc #251
Conversation
* Revise headings in some notebooks so that second-level headings (Overview) do not appear in the TOC.
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Click to view CI ResultsGitHub pull request #251 of commit bd351afdc828f5995947ab5920ecaf01251a205c, no merge conflicts. Running as SYSTEM Setting status of bd351afdc828f5995947ab5920ecaf01251a205c to PENDING with url https://10.20.13.93:8080/job/merlin_merlin/53/console and message: 'Pending' Using context: Jenkins Building on master in workspace /var/jenkins_home/workspace/merlin_merlin using credential systems-login > git rev-parse --is-inside-work-tree # timeout=10 Fetching changes from the remote Git repository > git config remote.origin.url https://github.com/NVIDIA-Merlin/Merlin # timeout=10 Fetching upstream changes from https://github.com/NVIDIA-Merlin/Merlin > git --version # timeout=10 using GIT_ASKPASS to set credentials login for merlin-systems > git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/Merlin +refs/pull/251/*:refs/remotes/origin/pr/251/* # timeout=10 > git rev-parse bd351afdc828f5995947ab5920ecaf01251a205c^{commit} # timeout=10 Checking out Revision bd351afdc828f5995947ab5920ecaf01251a205c (detached) > git config core.sparsecheckout # timeout=10 > git checkout -f bd351afdc828f5995947ab5920ecaf01251a205c # timeout=10 Commit message: "docs: Use MyST and sphinx-external-toc" > git rev-list --no-walk 80ae7e79d80a714e344f34e71bf4a900f144d88e # timeout=10 [merlin_merlin] $ /bin/bash /tmp/jenkins771258200040721822.sh ============================= test session starts ============================== platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0 rootdir: /var/jenkins_home/workspace/merlin_merlin/merlin plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0 collected 1 item |
Documentation preview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good. I'm wondering if the introduction isn't a better starting point than what's currently in the home link? But a great starting point.
The Intro--the README--is definitely more informative. I'm open to experimenting, but for the moment, my inclination is that a spare initial page might be OK because A) the navigation has a temptingly named "Introduction" item and B) the spare page definitely won't overwhelm readers. |
second-level headings (Overview) do not appear
in the TOC.