Skip to content

[ENH] Multi-version documentation #566

Description

@genedan

Sphinx has support for multi-version documentation, it would be useful as the project grows since it will help people identify version-to-version API changes and bugs:

Image

Activity

  1. moved this from Not Ready to In progress in Chainladder-Python Project Boardon Sep 20, 2026
  2. added a commit that references this issue on Sep 20, 2026
  3. genedan commented on Sep 22, 2026

    @genedan
    MemberAuthor

    I have a draft up in #1407, it removes the RTD flyover in the lower right hand corner and replaces it with a dropdown version menu at the top.

    However, I'm not sure it's worth the effort since this is a mostly trivial thing to implement on a non-RTD host, that we could revisit later if we ever move.

    Instead, @kennethshsu, could we put up a few more version numbers in the flyover, like 0.10.0 and 0.9.2? Having the most recent minor releases (I would recommend 3) would help people track deprecations, especially now that we have a process in inplace:

    Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Great First Contribution! 🌱Beginner friendly tickets with narrow scope and huge impact. Perfect to get your feet wet!

    Fields

    Priority

    Medium

    Effort

    Medium

    Scope

    Documentation

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions