scikit-learn website and documentation
From the styling point of view, I am a big fan of this one [1] that you
Dear list, dear devs, I have started to look at the scikit-learn documentation: talking with developers in July here in Paris, it seemed that you all are concerned by a reorganization / relooking of the doc and nothing is better than a naïve beginner to check the effectiveness of a doc ... right? ;) ... and diving into the docs allows me to better familiarize with the project... :) As CSS and HTML5 are a bit more fun than reStructuredText I've started to play with styling together with the sphinx contents ... contents ask for more focusing ... I will be more serious on that starting from September ... probably already know and I tried to apply those amazing styles to sphinx documentation. Then I saw the Andreas tweet [2] ... and decided to stop by to sum up. I've prepared a mock-up for the webpage available here [3]. It's a standard build of the doc with the editorial [4] styling (basic customization needs improvements). The code is available here [5]. I've tried not to move too far from the original visual ... because history is important, especially when you have one! :) I've focused on the homepage so don't expect big modifications in the doc itself. This is just a proof of concept. If you think I'm on the right track let me know... I will be happy to be useful on that. If not, or you already have someone taking care of that, please let me know too and I will find something else to do. Thanks for reading me. Best, Chiara [1] https://html5up.net/ [2] https://twitter.com/amuellerml/status/1161298913841885184 [3] https://cmarmo.github.io/mockup-skl/ [4] https://html5up.net/editorial [5] https://github.com/cmarmo/scikit-learn
Hi Chiara, Thanks for giving it a shot! I think we can end-up with a nice result with this theme too. Is this something you'd like to work on more seriously in the future, or just something to get you started on scikit-learn in general? (Basically, should Andy still be looking for a web-designer?) Nicolas On 8/18/19 9:43 AM, Chiara Marmo wrote:
Dear list, dear devs,
I have started to look at the scikit-learn documentation: talking with developers in July here in Paris, it seemed that you all are concerned by a reorganization / relooking of the doc and nothing is better than a naïve beginner to check the effectiveness of a doc ... right? ;) ... and diving into the docs allows me to better familiarize with the project... :)
As CSS and HTML5 are a bit more fun than reStructuredText I've started to play with styling together with the sphinx contents ... contents ask for more focusing ... I will be more serious on that starting from September ...
From the styling point of view, I am a big fan of this one [1] that you probably already know and I tried to apply those amazing styles to sphinx documentation. // Then I saw the Andreas tweet [2] ... and decided to stop by to sum up.
I've prepared a mock-up for the webpage available here [3]. It's a standard build of the doc with the editorial [4] styling (basic customization needs improvements). The code is available here [5]. I've tried not to move too far from the original visual ... because history is important, especially when you have one! :)
I've focused on the homepage so don't expect big modifications in the doc itself. This is just a proof of concept. If you think I'm on the right track let me know... I will be happy to be useful on that. If not, or you already have someone taking care of that, please let me know too and I will find something else to do.
Thanks for reading me.
Best,
Chiara
[1] https://html5up.net/ [2] https://twitter.com/amuellerml/status/1161298913841885184 [3] https://cmarmo.github.io/mockup-skl/ [4] https://html5up.net/editorial [5] https://github.com/cmarmo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Hi everyone, One thing to keep in mind with regards to technical solution is that it is much easier if they play well with sphinx. In other words, fully fledged frameworks tend to be harder to slot in. One tool that I really like is pure css, (https://purecss.io/), because it is very lightweight (it's only css, a the name suggests). Gaël Sent from my phone. Please forgive typos and briefness. On Aug 22, 2019, 16:21, at 16:21, Nicolas Hug <niourf@gmail.com> wrote:
Hi Chiara,
Thanks for giving it a shot! I think we can end-up with a nice result with this theme too.
Is this something you'd like to work on more seriously in the future, or just something to get you started on scikit-learn in general? (Basically, should Andy still be looking for a web-designer?)
Nicolas
On 8/18/19 9:43 AM, Chiara Marmo wrote:
Dear list, dear devs,
I have started to look at the scikit-learn documentation: talking with developers in July here in Paris, it seemed that you all are concerned by a reorganization / relooking of the doc and nothing is better than
a naïve beginner to check the effectiveness of a doc ... right? ;) ... and diving into the docs allows me to better familiarize with the
project... :)
As CSS and HTML5 are a bit more fun than reStructuredText I've started to play with styling together with the sphinx contents ... contents ask for more focusing ... I will be more serious on that starting from September ...
From the styling point of view, I am a big fan of this one [1] that you probably already know and I tried to apply those amazing styles to sphinx documentation. // Then I saw the Andreas tweet [2] ... and decided to stop by to sum up.
I've prepared a mock-up for the webpage available here [3]. It's a standard build of the doc with the editorial [4] styling (basic customization needs improvements). The code is available here [5]. I've tried not to move too far from the original visual ... because history is important, especially when you have one! :)
I've focused on the homepage so don't expect big modifications in the
doc itself. This is just a proof of concept. If you think I'm on the right track let me know... I will be happy to be useful on that. If not, or you already have someone taking care of that, please let me know too and I will find something else to do.
Thanks for reading me.
Best,
Chiara
[1] https://html5up.net/ [2] https://twitter.com/amuellerml/status/1161298913841885184 [3] https://cmarmo.github.io/mockup-skl/ [4] https://html5up.net/editorial [5] https://github.com/cmarmo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
------------------------------------------------------------------------
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Hi everyone,
One thing to keep in mind with regards to technical solution is that it is much easier if they play well with sphinx. In other words, fully fledged
Hi Nicolas, Working on visual and contents of the the docs is in my skills and I'm happy to finish the job. But I'm not a web designer and I don't like to impose myself... :) Maybe you can check at the Monday meeting if everybody is ok with that and write down comments in the minutes? For the next meeting I will be available for collecting specifications, if any. Gaël, I will check purecss.io: how much customization the basic theme needs has to be considered too. CiaoCiao Chiara On Friday, August 23, 2019, Gael Varoquaux <gael.varoquaux@normalesup.org> wrote: frameworks tend to be harder to slot in.
One tool that I really like is pure css, (https://purecss.io/), because
it is very lightweight (it's only css, a the name suggests).
Gaël
Sent from my phone. Please forgive typos and briefness. On Aug 22, 2019, at 16:21, Nicolas Hug <niourf@gmail.com> wrote:
Hi Chiara,
Thanks for giving it a shot! I think we can end-up with a nice result
Is this something you'd like to work on more seriously in the future, or
just something to get you started on scikit-learn in general? (Basically, should Andy still be looking for a web-designer?)
Nicolas
On 8/18/19 9:43 AM, Chiara Marmo wrote:
Dear list, dear devs, I have started to look at the scikit-learn documentation: talking with
developers in July here in Paris, it seemed that you all are concerned by a reorganization / relooking of the doc and nothing is better than a naïve beginner to check the effectiveness of a doc ... right? ;)
... and diving into the docs allows me to better familiarize with the
As CSS and HTML5 are a bit more fun than reStructuredText I've started
to play with styling together with the sphinx contents ... contents ask for more focusing ... I will be more serious on that starting from September ...
From the styling point of view, I am a big fan of this one [1] that you
Then I saw the Andreas tweet [2] ... and decided to stop by to sum up.
I've prepared a mock-up for the webpage available here [3]. It's a standard build of the doc with the editorial [4] styling (basic customization needs improvements). The code is available here [5]. I've tried not to move too far from the original visual ... because history is important, especially when you have one! :)
I've focused on the homepage so don't expect big modifications in the doc itself. This is just a proof of concept. If you think I'm on the right
with this theme too. project... :) probably already know and I tried to apply those amazing styles to sphinx documentation. track let me know... I will be happy to be useful on that.
If not, or you already have someone taking care of that, please let me know too and I will find something else to do.
Thanks for reading me. Best, Chiara
[1] https://html5up.net/ [2] https://twitter.com/amuellerml/status/1161298913841885184 [3] https://cmarmo.github.io/mockup-skl/ [4] https://html5up.net/editorial [5] https://github.com/cmarmo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Hello, Should I consider this PR [1] as an answer? ;) Cheers, Chiara [1] https://github.com/scikit-learn/scikit-learn/pull/14849 On Sat, Aug 24, 2019 at 1:53 PM Chiara Marmo <marmochiaskl@gmail.com> wrote:
Hi Nicolas,
Working on visual and contents of the the docs is in my skills and I'm happy to finish the job. But I'm not a web designer and I don't like to impose myself... :)
Maybe you can check at the Monday meeting if everybody is ok with that and write down comments in the minutes? For the next meeting I will be available for collecting specifications, if any.
Gaël, I will check purecss.io: how much customization the basic theme needs has to be considered too.
CiaoCiao
Chiara
Hello Chiara, as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme. If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS. Reviews of that PR would also be very much appreciated. -- Roman On 30/08/2019 18:58, Chiara Marmo wrote:
Hello,
Should I consider this PR [1] as an answer? ;)
Cheers, Chiara
[1] https://github.com/scikit-learn/scikit-learn/pull/14849
On Sat, Aug 24, 2019 at 1:53 PM Chiara Marmo <marmochiaskl@gmail.com <mailto:marmochiaskl@gmail.com>> wrote:
Hi Nicolas,
Working on visual and contents of the the docs is in my skills and I'm happy to finish the job. But I'm not a web designer and I don't like to impose myself... :)
Maybe you can check at the Monday meeting if everybody is ok with that and write down comments in the minutes? For the next meeting I will be available for collecting specifications, if any.
Gaël, I will check purecss.io <http://purecss.io>: how much customization the basic theme needs has to be considered too.
CiaoCiao
Chiara
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Hello Roman, thanks for your answer. Much appreciated. Cheers, Chiara On Mon, Sep 2, 2019 at 3:16 PM Roman Yurchak <rth.yurchak@gmail.com> wrote:
Hello Chiara,
as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme.
If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS.
Reviews of that PR would also be very much appreciated.
-- Roman
On 30/08/2019 18:58, Chiara Marmo wrote:
Hello,
Should I consider this PR [1] as an answer? ;)
Cheers, Chiara
Hi there, I hope I am not intruding ...but the mock-up website https://cmarmo.github.io/mockup-skl/ has a little unusual effect while scrolling on Firefox 69.0. Please check the attached screen capture. On Wed, Sep 4, 2019 at 10:23 AM Chiara Marmo <marmochiaskl@gmail.com> wrote:
Hello Roman,
thanks for your answer. Much appreciated.
Cheers, Chiara
On Mon, Sep 2, 2019 at 3:16 PM Roman Yurchak <rth.yurchak@gmail.com> wrote:
Hello Chiara,
as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme.
If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS.
Reviews of that PR would also be very much appreciated.
-- Roman
On 30/08/2019 18:58, Chiara Marmo wrote:
Hello,
Should I consider this PR [1] as an answer? ;)
Cheers, Chiara
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
@Sim - I can reproduce this on Chrome too ... It happens for narrow viewports where there is no gutter around the main content. Up to a width of 1280px, the sidebar behaves, I assume, correctly - as it does with mobile view - opening up from the hamburger-menu over the content. For super-wide screens, the sidebar lands in the left-gutter on scrolling, and doesn't interfere, but inbetween the sidebar will appear over the content as in Sim's message, as the gutter isn't there anymore. One can quick-fix this my just making the problem-media-width behave like that of the mobile/ipad widths - else one needs to look at the position and flex configuration of the content vs. the sidebar, to maybe make the sidebar *push* the content to the right when open (if there is no gutter). Just my two cents - Looks cool beyond the glitch :) El lun., 9 de sep. de 2019 a la(s) 12:32, Sim a (sim4n6@gmail.com) escribió:
Hi there,
I hope I am not intruding ...but the mock-up website https://cmarmo.github.io/mockup-skl/ has a little unusual effect while scrolling on Firefox 69.0. Please check the attached screen capture.
On Wed, Sep 4, 2019 at 10:23 AM Chiara Marmo <marmochiaskl@gmail.com> wrote:
Hello Roman,
thanks for your answer. Much appreciated.
Cheers, Chiara
On Mon, Sep 2, 2019 at 3:16 PM Roman Yurchak <rth.yurchak@gmail.com> wrote:
Hello Chiara,
as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme.
If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS.
Reviews of that PR would also be very much appreciated.
-- Roman
On 30/08/2019 18:58, Chiara Marmo wrote:
Hello,
Should I consider this PR [1] as an answer? ;)
Cheers, Chiara
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Sorry to spam - here's a little gif to show the behaviour and problem area: [image: responsive-sidenav.gif] One would need to decide on what the desktop behavior of the sideNav will be. ipad/mobile is fine IMHO. Hope this helps :) El lun., 9 de sep. de 2019 a la(s) 13:02, Jaques Grobler ( jaquesgrobler@gmail.com) escribió:
@Sim - I can reproduce this on Chrome too ... It happens for narrow viewports where there is no gutter around the main content.
Up to a width of 1280px, the sidebar behaves, I assume, correctly - as it does with mobile view - opening up from the hamburger-menu over the content. For super-wide screens, the sidebar lands in the left-gutter on scrolling, and doesn't interfere, but inbetween the sidebar will appear over the content as in Sim's message, as the gutter isn't there anymore.
One can quick-fix this my just making the problem-media-width behave like that of the mobile/ipad widths - else one needs to look at the position and flex configuration of the content vs. the sidebar, to maybe make the sidebar *push* the content to the right when open (if there is no gutter).
Just my two cents - Looks cool beyond the glitch :)
El lun., 9 de sep. de 2019 a la(s) 12:32, Sim a (sim4n6@gmail.com) escribió:
Hi there,
I hope I am not intruding ...but the mock-up website https://cmarmo.github.io/mockup-skl/ has a little unusual effect while scrolling on Firefox 69.0. Please check the attached screen capture.
On Wed, Sep 4, 2019 at 10:23 AM Chiara Marmo <marmochiaskl@gmail.com> wrote:
Hello Roman,
thanks for your answer. Much appreciated.
Cheers, Chiara
On Mon, Sep 2, 2019 at 3:16 PM Roman Yurchak <rth.yurchak@gmail.com> wrote:
Hello Chiara,
as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme.
If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS.
Reviews of that PR would also be very much appreciated.
-- Roman
On 30/08/2019 18:58, Chiara Marmo wrote:
Hello,
Should I consider this PR [1] as an answer? ;)
Cheers, Chiara
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
Hi Jacques and Sim, Thanks a lot for you input. As previously mentionned though, we will be moving forward with https://github.com/scikit-learn/scikit-learn/pull/14849 instead of the original proposal. Any feedback on this PR would be greatly appreciated too! Nicolas On 9/9/19 7:08 AM, Jaques Grobler wrote:
Sorry to spam - here's a little gif to show the behaviour and problem area:
responsive-sidenav.gif
One would need to decide on what the desktop behavior of the sideNav will be. ipad/mobile is fine IMHO.
Hope this helps :)
El lun., 9 de sep. de 2019 a la(s) 13:02, Jaques Grobler (jaquesgrobler@gmail.com <mailto:jaquesgrobler@gmail.com>) escribió:
@Sim - I can reproduce this on Chrome too ... It happens for narrow viewports where there is no gutter around the main content.
Up to a width of 1280px, the sidebar behaves, I assume, correctly - as it does with mobile view - opening up from the hamburger-menu over the content. For super-wide screens, the sidebar lands in the left-gutter on scrolling, and doesn't interfere, but inbetween the sidebar will appear over the content as in Sim's message, as the gutter isn't there anymore.
One can quick-fix this my just making the problem-media-width behave like that of the mobile/ipad widths - else one needs to look at the position and flex configuration of the content vs. the sidebar, to maybe make the sidebar /push/ the content to the right when open (if there is no gutter).
Just my two cents - Looks cool beyond the glitch :)
El lun., 9 de sep. de 2019 a la(s) 12:32, Sim a (sim4n6@gmail.com <mailto:sim4n6@gmail.com>) escribió:
Hi there,
I hope I am not intruding ...but the mock-up website https://cmarmo.github.io/mockup-skl/ has a little unusual effect while scrolling on Firefox 69.0. Please check the attached screen capture.
On Wed, Sep 4, 2019 at 10:23 AM Chiara Marmo <marmochiaskl@gmail.com <mailto:marmochiaskl@gmail.com>> wrote:
Hello Roman,
thanks for your answer. Much appreciated.
Cheers, Chiara
On Mon, Sep 2, 2019 at 3:16 PM Roman Yurchak <rth.yurchak@gmail.com <mailto:rth.yurchak@gmail.com>> wrote:
Hello Chiara,
as far as I understood scikit-learn#14849 started as an incremental improvement of the scikit-learn website and ended up as a more in depth rewrite of the sphinx theme.
If you have any comments or suggestions don't hesitate to comment on that issue. For instance, that PR went with Boostrap and I'm wondering about be the advantages/limitations with respect to using something like PureCSS.
Reviews of that PR would also be very much appreciated.
-- Roman
On 30/08/2019 18:58, Chiara Marmo wrote: > Hello, > > Should I consider this PR [1] as an answer? ;) > > Cheers, > Chiara > > [1] https://github.com/scikit-learn/scikit-learn/pull/14849
_______________________________________________ scikit-learn mailing list scikit-learn@python.org <mailto:scikit-learn@python.org> https://mail.python.org/mailman/listinfo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org <mailto:scikit-learn@python.org> https://mail.python.org/mailman/listinfo/scikit-learn
_______________________________________________ scikit-learn mailing list scikit-learn@python.org https://mail.python.org/mailman/listinfo/scikit-learn
participants (6)
-
Chiara Marmo -
Gael Varoquaux -
Jaques Grobler -
Nicolas Hug -
Roman Yurchak -
Sim a