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

[Enhancement] Versionning documentation #133

Closed
leleogere opened this issue Jan 22, 2024 · 4 comments
Closed

[Enhancement] Versionning documentation #133

leleogere opened this issue Jan 22, 2024 · 4 comments

Comments

@leleogere
Copy link
Contributor

this docs is a bit too "up-to-date" as it concerns the incoming MidiTok V3 but the concerned paragraph is still 100% relevant

As you mentioned in this comment, the current documentation might not match the version of Miditok that people are using. It would be very useful to be able to use the bottom-left button of the website to see the documentation of a particular version. Currently, we can see that all versions are referenced, but only the last one is documented. Clicking on any of the previous versions ends up on a 404 error.

image

image

@Natooz
Copy link
Owner

Natooz commented Jan 22, 2024

I do not get 404 errors when I try older versions.
Are you accessing to a particular page that might not exist on older versions?

https://miditok.readthedocs.io/en/v2.1.8/

@leleogere
Copy link
Contributor Author

Woops, that's my bad, I was on a page that didn't exist previously indeed... Problem solved I guess! 😅

@leleogere
Copy link
Contributor Author

leleogere commented Jan 22, 2024

The issue was that I was on the "Bases" page (first item on the left menu, as showed in my screenshots), which I expected to be in most versions. I appear that it exists both in 3.0.0 and 2.1.8 (and earlier), but that do not share the same URL. In 3.0.0, the "Bases" is located at ..../bases.html, and in 2.1.8 (and earlier) it is located at ..../midi_tokenizer.html. So when you switch versions on this page, you get a 404 error.

@Natooz
Copy link
Owner

Natooz commented Jan 22, 2024

Indeed the doc file has been renamed to match the page title 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants