Skip to content
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

Merged
merged 65 commits into from
Nov 18, 2021
Merged

Port from Gitbook to sphinx #21

merged 65 commits into from
Nov 18, 2021

Commits on Nov 11, 2021

  1. Run sphinx-quickstart

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    38f978e View commit details
    Browse the repository at this point in the history
  2. Use sphinx-book-theme

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    7b37c12 View commit details
    Browse the repository at this point in the history
  3. 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
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    5fbfff5 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    fb4a81a View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    7680805 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    baae5fb View commit details
    Browse the repository at this point in the history
  7. Theme the table of contents.

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    cdfcdf4 View commit details
    Browse the repository at this point in the history
  8. Hide toctrees from main content.

    They should only show in the sidebar.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    bb6313f View commit details
    Browse the repository at this point in the history
  9. Use smooth scrolling when clicking intra-page links.

    i.e. when clicking links on the secondary :contents: navbar.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    dc90dd6 View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    50549e1 View commit details
    Browse the repository at this point in the history
  11. Auto-publish to github pages.

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    b7f170e View commit details
    Browse the repository at this point in the history
  12. Use custom domaim

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    bbad19f View commit details
    Browse the repository at this point in the history
  13. Trigger build on PR branch

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    a625081 View commit details
    Browse the repository at this point in the history
  14. Edit On Github -> Edit on PR branch.

    This is a temporary measure, for demoing.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    5f0b544 View commit details
    Browse the repository at this point in the history
  15. 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...
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    f91a603 View commit details
    Browse the repository at this point in the history
  16. Don't name files filename.md.txt, just use filename.md.

    Not that we actually use the _sources feature.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    ea9550d View commit details
    Browse the repository at this point in the history
  17. Configuration menu
    Copy the full SHA
    787abad View commit details
    Browse the repository at this point in the history
  18. Configuration menu
    Copy the full SHA
    3cc1cb1 View commit details
    Browse the repository at this point in the history
  19. Configuration menu
    Copy the full SHA
    245fcd3 View commit details
    Browse the repository at this point in the history
  20. Shrink font

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    f353f75 View commit details
    Browse the repository at this point in the history
  21. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    dfde272 View commit details
    Browse the repository at this point in the history
  22. Repair broken embedded PDFs

    Gitbook's {% embed %} tag calls out to iframe.ly which calls out to
    slideshare.net. Just get the slideshare embed code directly.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    c2c7263 View commit details
    Browse the repository at this point in the history
  23. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    9033b96 View commit details
    Browse the repository at this point in the history
  24. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    f2f2a37 View commit details
    Browse the repository at this point in the history
  25. Embed lab calendar.

    This is more our internal calendar, and should probably be on neuropoly-internal-docs.
    Do we have a better public-facing option?
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    396d86d View commit details
    Browse the repository at this point in the history
  26. Update events-and-workshops.md

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    0c2e9de View commit details
    Browse the repository at this point in the history
  27. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    fcbd7c1 View commit details
    Browse the repository at this point in the history
  28. 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
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    8d7c46c View commit details
    Browse the repository at this point in the history
  29. Try furo theme

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    b76b6c5 View commit details
    Browse the repository at this point in the history
  30. Revert "Try furo theme"

    This reverts commit f5f59dd.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    8e14b1b View commit details
    Browse the repository at this point in the history
  31. Configuration menu
    Copy the full SHA
    09d2b15 View commit details
    Browse the repository at this point in the history
  32. Configuration menu
    Copy the full SHA
    37a2d1e View commit details
    Browse the repository at this point in the history
  33. Remove redundant list of members from the sidebar.

    The secondary sidebar on /team/README.html is enough.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    305df8b View commit details
    Browse the repository at this point in the history
  34. Configuration menu
    Copy the full SHA
    13898f2 View commit details
    Browse the repository at this point in the history
  35. Unhide all sub-ToCs.

    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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    9f4293e View commit details
    Browse the repository at this point in the history
  36. Clearer sub-ToC title

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    10192b9 View commit details
    Browse the repository at this point in the history
  37. Configuration menu
    Copy the full SHA
    f890680 View commit details
    Browse the repository at this point in the history
  38. Software: split up links -> source/docs columns

    And make them iconified (on visual browsers, but still readable on
    screenreaders/lynx)
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    a7be9c4 View commit details
    Browse the repository at this point in the history
  39. Add some space in the table of contents after the emojis we use to hi…

    …ghlight our top-level pages
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    c6f4bae View commit details
    Browse the repository at this point in the history
  40. Simplify search bar text.

    This site isn't "docs", so "Search the docs" makes no sense.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    916724b View commit details
    Browse the repository at this point in the history
  41. Configuration menu
    Copy the full SHA
    aa5a9d8 View commit details
    Browse the repository at this point in the history
  42. Configuration menu
    Copy the full SHA
    bbe73ef View commit details
    Browse the repository at this point in the history
  43. Configuration menu
    Copy the full SHA
    b46a520 View commit details
    Browse the repository at this point in the history
  44. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    3d33d70 View commit details
    Browse the repository at this point in the history
  45. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    e16afbd View commit details
    Browse the repository at this point in the history
  46. Shrink embedded PDFs

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    3289aac View commit details
    Browse the repository at this point in the history
  47. Configuration menu
    Copy the full SHA
    d27ed35 View commit details
    Browse the repository at this point in the history
  48. Configuration menu
    Copy the full SHA
    41b2e13 View commit details
    Browse the repository at this point in the history
  49. $ signs are math in myst, oops

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    377e40c View commit details
    Browse the repository at this point in the history
  50. Update broken link.

    Personally, I would like to merge intranet.neuro into this wiki, and make this a relative link.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    91ecfb8 View commit details
    Browse the repository at this point in the history
  51. Styling

    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    a3e9fff View commit details
    Browse the repository at this point in the history
  52. Add gh profile URL

    hermancollin authored and kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    a884684 View commit details
    Browse the repository at this point in the history
  53. Add MHB GitHub profile URL

    mariehbourget authored and kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    487ba74 View commit details
    Browse the repository at this point in the history
  54. add cg github

    charleygros authored and kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    48bfacf View commit details
    Browse the repository at this point in the history
  55. /team/: tables -> lists

    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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    5cc86a7 View commit details
    Browse the repository at this point in the history
  56. /team/: Write social icons on separate lines.

    This makes the syntax easier to work with, but doesn't change
    the rendered layout.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    9052da1 View commit details
    Browse the repository at this point in the history
  57. /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
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    67bb91a View commit details
    Browse the repository at this point in the history
  58. Update README.md

    andreanne-lemay authored and kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    cd1576e View commit details
    Browse the repository at this point in the history
  59. 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)
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    fc5a247 View commit details
    Browse the repository at this point in the history
  60. Configuration menu
    Copy the full SHA
    12b4e4f View commit details
    Browse the repository at this point in the history
  61. 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.
    kousu committed Nov 11, 2021
    Configuration menu
    Copy the full SHA
    caa9952 View commit details
    Browse the repository at this point in the history

Commits on Nov 18, 2021

  1. Go to prod

    kousu committed Nov 18, 2021
    Configuration menu
    Copy the full SHA
    fc0f1fa View commit details
    Browse the repository at this point in the history
  2. 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.
    kousu committed Nov 18, 2021
    Configuration menu
    Copy the full SHA
    34d1a37 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    4c0a96b View commit details
    Browse the repository at this point in the history
  4. Match repository name to DNS

    kousu committed Nov 18, 2021
    Configuration menu
    Copy the full SHA
    df134ee View commit details
    Browse the repository at this point in the history