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

DOC - Enable viewing dev and stable versions of package documentation #206

Merged
merged 20 commits into from
Nov 14, 2023

Conversation

Badr-MOUFAD
Copy link
Collaborator

@Badr-MOUFAD Badr-MOUFAD commented Nov 8, 2023

Context of the PR

Currently, it is impossible for a user to view the documentation of the stable version 0.3.
As we keep updating the package (new features, bugs, ...) the dev version of the doc diverges from the stable one.

A brief preview of this PR contribution

preview

Close #203

Contributions of the PR

  • add a version toggler to switch between the dev and stable versions of the package documentation

Checks before merging PR

  • [ ] added documentation for any new feature
  • [ ] added unittests
  • [ ] edited the what's new

@mathurinm
Copy link
Collaborator

Thanks @Badr-MOUFAD ! On the CI build I get an error for https://output.circle-artifacts.com/output/job/724f72b1-185b-41e9-93cb-680e9da6ba85/artifacts/0/dev/stable/index.html when clicking on "stable version", is it normal ?

@Badr-MOUFAD
Copy link
Collaborator Author

Thanks @Badr-MOUFAD ! On the CI build I get an error for https://output.circle-artifacts.com/output/job/724f72b1-185b-41e9-93cb-680e9da6ba85/artifacts/0/dev/stable/index.html when clicking on "stable version", is it normal ?

Yes @mathurinm, it is normal to not see the stable version.
We haven't uploaded it yet, and if so, it won't appear in the artifacts as we expose only the dev version in Circleci.

@mathurinm
Copy link
Collaborator

How do you think we should test this? Do you add the stable folder in this PR?

@Badr-MOUFAD
Copy link
Collaborator Author

Badr-MOUFAD commented Nov 9, 2023

How do you think we should test this? Do you add the stable folder in this PR?

I exposed the stable doc skglm v0.3 in the artifact, (beforehand, I built it and pushed it to gh-pages)
Now, we have a mirror of what will be deployed to the website

doc/conf.py Outdated
"sidebar/brand.html",
"sidebar/search.html",
"sidebar/navigation.html",
"sidebar/version_toggler.html", # version toggler template
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Badr-MOUFAD maybe move it above as it contains important information? otherwise looking great!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing so, +small adjustments, we get this render

screenshot for render

Looks great @mathurinm, 👍 for this change

@mathurinm mathurinm merged commit c67a885 into scikit-learn-contrib:main Nov 14, 2023
2 checks passed
@mathurinm
Copy link
Collaborator

@PABannier this should fix the issue you had, thanks @Badr-MOUFAD !

@PABannier
Copy link
Collaborator

Thanks @Badr-MOUFAD !

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

Successfully merging this pull request may close these issues.

DOC add stable/dev versions of the doc
3 participants