Create versioned docs

[franciscojavierarceo]

trafficstars

🚀 Describe the new functionality needed

Currently our docs only show the latest version (see screenshot). Given the high volume of changes, this makes it challenging for users to run demos confidently.

💡 Why is this needed? What if we don't build it?

We should default to the latest release but allow users to select docs that map to prior releases.

Other thoughts

No response

[YassinNouh21]

@franciscojavierarceo

I’d like to propose an additional idea to make this even stronger. Alongside versioning the docs, we could also bring some automation into the codebase itself by tracking versions at the function or method level. This way, we’ll have a clear view not just of doc versions, but also of when functions were added or changed, and we can connect this directly to our documentation flow.

The goal is to make it easier to maintain over time and reduce manual work, while giving us better visibility across releases. Here’s how we could approach it step by step:

1 Enforce method versioning We could introduce simple decorators or docstring tags, like @since("1.5.0"), to mark when functions were introduced or updated. This will make tracking changes much easier and help us understand the evolution of our APIs and utilities.

2.Connect codebase metadata to docsWith these tags in place, we can automate parts of the documentation process. For example, if a method is introduced in version 1.5.0, it would automatically show up in the 1.5.0 section of the docs.

3.Integrate with CIFinally, we could enforce these checks in CI, so every new pull request ensures that new methods are properly versioned, duplicates are flagged, and our documentation stays in sync with the code.

Let me know your thoughts on this. I think it could complement the work on the docs very well.

[franciscojavierarceo]

I like that idea! If I'm to be honest, I'm concerned about putting too much burden on a rapidly evolving codebase.

[KPostOffice]

https://docs.readthedocs.com/platform/stable/guides/automation-rules.html

It looks like a lot of this can be solved just with configuration options on readthedocs by whoever has admin rights there

[franciscojavierarceo]

This is still outstanding but @terrytangyuan took a look at it. Looks like that didn't work though.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had activity within 60 days. It will be automatically closed if no further activity occurs within 30 days.

[github-actions[bot]]

This issue has been automatically closed due to inactivity. Please feel free to reopen if you feel it is still relevant!