Skip to content

Consider migrating from ReadTheDocs to GitHub pages #128

Closed
@vitaut

Description

@vitaut

Comparison of ReadTheDocs and GitHub pages:

  1. Time to load similar pages
    • GitHub: 0.70 - 1.57s
    • ReadTheDocs: 2.46 - 2.75s
  2. Compatiblity
    • ReadTheDocs interferes with Sphinx builds breaking some of the features (possibly due to their customizations).
    • GitHub Pages don't interfere with Sphinx build process
  3. Reliability
    • ReadTheDocs builds can remain broken for days without a way to cancel them.
    • Didn't notice any issues with GitHub pages so far.
  4. Versioning
    • ReadTheDocs automates this, but versioning doesn't integrate well with the page theme except for RTD theme. However the latter has major usability issues.
    • With GitHub pages this will have to be done manually, but can be better integrated into the theme

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions