mystmd icon indicating copy to clipboard operation
mystmd copied to clipboard

Published 20 hours ago • verified publisher icon jupyter-book

ReadTheDocs hosting support

Open LecrisUT opened this issue 1 year ago • 5 comments
trafficstars

ReadTheDocs is a key hosting platform for software documentation, and the current platform that Jupyter Book uses for its versioned documentation. There are a number of issues that degrade the user experience on ReadTheDocs and this issue is tracking the major ones to resolve to consider it "properly" supported.

Issues to resolve

Previews

  • [ ] The landing page of the preview is broken, due to some kind of javascript error

HTML redirects don't work for .html files

  • [x] Bare links need to redirect to .html files - this is now resolved!
    • https://github.com/executablebooks/mystmd/issues/984
  • [ ] Handle hydration issues for javascript to prevent flickering and the RTD flyout menu
    • MyST issue:https://github.com/executablebooks/mystmd/issues/997
    • RTD issue: https://github.com/readthedocs/addons/issues/278
  • [ ] Overwrite robots.txt

LecrisUT avatar Apr 18 '24 16:04 LecrisUT