-
Notifications
You must be signed in to change notification settings - Fork 7
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
Port from Gitbook to sphinx #21
Commits on Nov 11, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 38f978e - Browse repository at this point
Copy the full SHA 38f978eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 7b37c12 - Browse repository at this point
Copy the full SHA 7b37c12View commit details -
Glue Git{hub,book} and sphinx index pages together
Just symlink all index.md -> README.md Another route would be to set in conf.py root_doc = 'README' Which works, except that then all URLs will have README.html in them; it would work if we could configure the webserver hosting us to treat README.html as an index page, which we can do if we self-host, but that's probably not possible with most, and above all it's not a very portable solution. So instead: symlinks. Maybe there's a configuration option that can rewrite README -> index during the build. But that'll probably mess up something else somewhere. These were created with find . -name "README.md" | while read target; do ( cd $(dirname $target); ln -sf README.md index.md ); done
Configuration menu - View commit details
-
Copy full SHA for 5fbfff5 - Browse repository at this point
Copy the full SHA 5fbfff5View commit details -
Configuration menu - View commit details
-
Copy full SHA for fb4a81a - Browse repository at this point
Copy the full SHA fb4a81aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 7680805 - Browse repository at this point
Copy the full SHA 7680805View commit details -
Configuration menu - View commit details
-
Copy full SHA for baae5fb - Browse repository at this point
Copy the full SHA baae5fbView commit details -
Configuration menu - View commit details
-
Copy full SHA for cdfcdf4 - Browse repository at this point
Copy the full SHA cdfcdf4View commit details -
Configuration menu - View commit details
-
Copy full SHA for bb6313f - Browse repository at this point
Copy the full SHA bb6313fView commit details -
Use smooth scrolling when clicking intra-page links.
i.e. when clicking links on the secondary :contents: navbar.
Configuration menu - View commit details
-
Copy full SHA for dc90dd6 - Browse repository at this point
Copy the full SHA dc90dd6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 50549e1 - Browse repository at this point
Copy the full SHA 50549e1View commit details -
Configuration menu - View commit details
-
Copy full SHA for b7f170e - Browse repository at this point
Copy the full SHA b7f170eView commit details -
Configuration menu - View commit details
-
Copy full SHA for bbad19f - Browse repository at this point
Copy the full SHA bbad19fView commit details -
Configuration menu - View commit details
-
Copy full SHA for a625081 - Browse repository at this point
Copy the full SHA a625081View commit details -
Edit On Github -> Edit on PR branch.
This is a temporary measure, for demoing.
Configuration menu - View commit details
-
Copy full SHA for 5f0b544 - Browse repository at this point
Copy the full SHA 5f0b544View commit details -
Do README <-> index glue in a more stable way.
The old way meant: - clicking Edit On Github on an index page would go to a page that just said README.md - toctree's :glob: feature would get into an infinite loop if I use *; it's smart enough not to recurse into the calling page, but not to recurse into the symlinked copy of the calling page and then back again...
Configuration menu - View commit details
-
Copy full SHA for f91a603 - Browse repository at this point
Copy the full SHA f91a603View commit details -
Don't name files filename.md.txt, just use filename.md.
Not that we actually use the _sources feature.
Configuration menu - View commit details
-
Copy full SHA for ea9550d - Browse repository at this point
Copy the full SHA ea9550dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 787abad - Browse repository at this point
Copy the full SHA 787abadView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3cc1cb1 - Browse repository at this point
Copy the full SHA 3cc1cb1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 245fcd3 - Browse repository at this point
Copy the full SHA 245fcd3View commit details -
Configuration menu - View commit details
-
Copy full SHA for f353f75 - Browse repository at this point
Copy the full SHA f353f75View commit details -
Use :glob: to auto-generate the Team Table of Contents.
This means it's real easy to add yourself as a new member: just create a page.
Configuration menu - View commit details
-
Copy full SHA for dfde272 - Browse repository at this point
Copy the full SHA dfde272View commit details -
Gitbook's {% embed %} tag calls out to iframe.ly which calls out to slideshare.net. Just get the slideshare embed code directly.
Configuration menu - View commit details
-
Copy full SHA for c2c7263 - Browse repository at this point
Copy the full SHA c2c7263View commit details -
Move embedded PDFs from SlideShare to *here*
Firefox and Chrome both, finally, after years, have good working native PDF <embed> support. I even managed to get the boxes sized to fit 16:9 or 4:3 aspect PDFs.
Configuration menu - View commit details
-
Copy full SHA for 9033b96 - Browse repository at this point
Copy the full SHA 9033b96View commit details -
Align navbar control button with navbar on large screens.
I broke it in "Widen page to ensure navbar is always flush to the left." by expanding the main content but not matching the topbar to it.
Configuration menu - View commit details
-
Copy full SHA for f2f2a37 - Browse repository at this point
Copy the full SHA f2f2a37View commit details -
This is more our internal calendar, and should probably be on neuropoly-internal-docs. Do we have a better public-facing option?
Configuration menu - View commit details
-
Copy full SHA for 396d86d - Browse repository at this point
Copy the full SHA 396d86dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 0c2e9de - Browse repository at this point
Copy the full SHA 0c2e9deView commit details -
Point Events' youtube link at the conferences playlist.
"Follow Us On" was a non-sequitur on the events page. Move "Follow Us On" next to the front page Twitter icon.
Configuration menu - View commit details
-
Copy full SHA for fcbd7c1 - Browse repository at this point
Copy the full SHA fcbd7c1View commit details -
Mobile-friendly embedded PDFs.
It turns out I'd misread some things. I thought you were supposed to put embeds inside objects, but actually objects supersede embeds. See https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Other_embedding_technologies#the_embed_and_object_elements
Configuration menu - View commit details
-
Copy full SHA for 8d7c46c - Browse repository at this point
Copy the full SHA 8d7c46cView commit details -
Configuration menu - View commit details
-
Copy full SHA for b76b6c5 - Browse repository at this point
Copy the full SHA b76b6c5View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8e14b1b - Browse repository at this point
Copy the full SHA 8e14b1bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 09d2b15 - Browse repository at this point
Copy the full SHA 09d2b15View commit details -
Configuration menu - View commit details
-
Copy full SHA for 37a2d1e - Browse repository at this point
Copy the full SHA 37a2d1eView commit details -
Remove redundant list of members from the sidebar.
The secondary sidebar on /team/README.html is enough.
Configuration menu - View commit details
-
Copy full SHA for 305df8b - Browse repository at this point
Copy the full SHA 305df8bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 13898f2 - Browse repository at this point
Copy the full SHA 13898f2View commit details -
Several people gave feedback that it was confusing having the empty pages these left. I also unhid the not-quite-empty research/ page, since it's /basically/ empty anyway.
Configuration menu - View commit details
-
Copy full SHA for 9f4293e - Browse repository at this point
Copy the full SHA 9f4293eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 10192b9 - Browse repository at this point
Copy the full SHA 10192b9View commit details -
Configuration menu - View commit details
-
Copy full SHA for f890680 - Browse repository at this point
Copy the full SHA f890680View commit details -
Software: split up links -> source/docs columns
And make them iconified (on visual browsers, but still readable on screenreaders/lynx)
Configuration menu - View commit details
-
Copy full SHA for a7be9c4 - Browse repository at this point
Copy the full SHA a7be9c4View commit details -
Add some space in the table of contents after the emojis we use to hi…
…ghlight our top-level pages
Configuration menu - View commit details
-
Copy full SHA for c6f4bae - Browse repository at this point
Copy the full SHA c6f4baeView commit details -
This site isn't "docs", so "Search the docs" makes no sense.
Configuration menu - View commit details
-
Copy full SHA for 916724b - Browse repository at this point
Copy the full SHA 916724bView commit details -
Configuration menu - View commit details
-
Copy full SHA for aa5a9d8 - Browse repository at this point
Copy the full SHA aa5a9d8View commit details -
Configuration menu - View commit details
-
Copy full SHA for bbe73ef - Browse repository at this point
Copy the full SHA bbe73efView commit details -
Configuration menu - View commit details
-
Copy full SHA for b46a520 - Browse repository at this point
Copy the full SHA b46a520View commit details -
Revert "Add some space in the table of contents after the emojis we u…
…se to highlight our top-level pages" This reverts commit 02daeff.
Configuration menu - View commit details
-
Copy full SHA for 3d33d70 - Browse repository at this point
Copy the full SHA 3d33d70View commit details -
Add space between emojis and titles in ToC
This is a stupid way to do it but it preserves the #anchor links which seems more important.
Configuration menu - View commit details
-
Copy full SHA for e16afbd - Browse repository at this point
Copy the full SHA e16afbdView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3289aac - Browse repository at this point
Copy the full SHA 3289aacView commit details -
Configuration menu - View commit details
-
Copy full SHA for d27ed35 - Browse repository at this point
Copy the full SHA d27ed35View commit details -
Configuration menu - View commit details
-
Copy full SHA for 41b2e13 - Browse repository at this point
Copy the full SHA 41b2e13View commit details -
Configuration menu - View commit details
-
Copy full SHA for 377e40c - Browse repository at this point
Copy the full SHA 377e40cView commit details -
Personally, I would like to merge intranet.neuro into this wiki, and make this a relative link.
Configuration menu - View commit details
-
Copy full SHA for 91ecfb8 - Browse repository at this point
Copy the full SHA 91ecfb8View commit details -
Configuration menu - View commit details
-
Copy full SHA for a3e9fff - Browse repository at this point
Copy the full SHA a3e9fffView commit details -
Configuration menu - View commit details
-
Copy full SHA for a884684 - Browse repository at this point
Copy the full SHA a884684View commit details -
Configuration menu - View commit details
-
Copy full SHA for 487ba74 - Browse repository at this point
Copy the full SHA 487ba74View commit details -
Configuration menu - View commit details
-
Copy full SHA for 48bfacf - Browse repository at this point
Copy the full SHA 48bfacfView commit details -
Lists have an easier syntax, especially since we only have one column in these tables. Maybe we'll have multiple columns again in the future, but I think at that point I will be scraping Github profiles to *generate* the content, and so prettiness will be irrelevant. But for now it is relevant.
Configuration menu - View commit details
-
Copy full SHA for 5cc86a7 - Browse repository at this point
Copy the full SHA 5cc86a7View commit details -
/team/: Write social icons on separate lines.
This makes the syntax easier to work with, but doesn't change the rendered layout.
Configuration menu - View commit details
-
Copy full SHA for 9052da1 - Browse repository at this point
Copy the full SHA 9052da1View commit details -
/team/: Use FontAwesome social icons, to unify the theme.
These icons are used in the Github Button and on /software.html; this just makes everything consistent. This migration was done with these ridiculous perl one-liners: perl -i -pe 's/\[\!\[(.*?)\].*\((https:.*)\)/[<i class="fab fa-\L\1\E" title="\1" aria-hidden="true"><\/i><span>\1<\/span>]\(\2)/' team/README.md && perl -i -pe 's/\[\!\[(E-Mail)\].*\((mailto:.*)\)/[<i class="fa fa-envelope" title="\1" aria-hidden="true"><\/i><span>\1<\/span>]\(\2)/' team/README.md
Configuration menu - View commit details
-
Copy full SHA for 67bb91a - Browse repository at this point
Copy the full SHA 67bb91aView commit details -
Configuration menu - View commit details
-
Copy full SHA for cd1576e - Browse repository at this point
Copy the full SHA cd1576eView commit details -
events-and-workshops: usable calendar subscription links.
Just repeating the embed URL is what https://executablebooks.org/en/latest/meetings/index.html?highlight=calendar does, but that's pretty pointless: you still have to click the "+ Google Calendar" button in the corner on that page ...which is already visible in the embedded calendar. Now there's one link that prompts you to subscribe, if you're logged in to Google, and one that works with every other apps (because it's .ics)
Configuration menu - View commit details
-
Copy full SHA for fc5a247 - Browse repository at this point
Copy the full SHA fc5a247View commit details -
Configuration menu - View commit details
-
Copy full SHA for 12b4e4f - Browse repository at this point
Copy the full SHA 12b4e4fView commit details -
Pin sphinx's version until sphinx-book-theme bug is fixed.
Something is wrong with sphinx-book-theme in a way that broke when sphinx went from 4.2.0 to 4.3.0 this week.
Configuration menu - View commit details
-
Copy full SHA for caa9952 - Browse repository at this point
Copy the full SHA caa9952View commit details
Commits on Nov 18, 2021
-
Configuration menu - View commit details
-
Copy full SHA for fc0f1fa - Browse repository at this point
Copy the full SHA fc0f1faView commit details -
Shrink overly-wide sidebar again.
This doesn't actually do anything here right now, but was discovered in https://github.com/neuropoly/neuropoly-internal-docs/, which has sphinx-panels enabled. If we enable sphinx-panels here too, we'll need the same patch.
Configuration menu - View commit details
-
Copy full SHA for 34d1a37 - Browse repository at this point
Copy the full SHA 34d1a37View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4c0a96b - Browse repository at this point
Copy the full SHA 4c0a96bView commit details -
Configuration menu - View commit details
-
Copy full SHA for df134ee - Browse repository at this point
Copy the full SHA df134eeView commit details