-
Notifications
You must be signed in to change notification settings - Fork 34
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
DOC - Enable viewing dev and stable versions of package documentation #206
Conversation
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. |
How do you think we should test this? Do you add the |
I exposed the stable doc skglm v0.3 in the artifact, (beforehand, I built it and pushed it to |
doc/conf.py
Outdated
"sidebar/brand.html", | ||
"sidebar/search.html", | ||
"sidebar/navigation.html", | ||
"sidebar/version_toggler.html", # version toggler template |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PABannier this should fix the issue you had, thanks @Badr-MOUFAD ! |
Thanks @Badr-MOUFAD ! |
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
Close #203
Contributions of the PR
Checks before merging PR
[ ] added documentation for any new feature[ ] added unittests[ ] edited the what's new