scikit-learn-contrib / lightning

Large-scale linear classification, regression and ranking in Python
https://contrib.scikit-learn.org/lightning/
1.73k stars 214 forks source link

update docs at GitHub Pages #172

Closed StrikerRUS closed 3 years ago

StrikerRUS commented 3 years ago

Refer to https://github.com/scikit-learn-contrib/lightning/pull/170#issuecomment-835533239.

I wasn't able to re-generate the whole site (mostly because I'm on Windows), but I was able to generate everything except examples and then manually insert important changes into the current html pages.

StrikerRUS commented 3 years ago
How index.html looks like now (click to enlarge): ![image](https://user-images.githubusercontent.com/25141164/117708173-2662e600-b1d8-11eb-9755-7a7f5e5dc4c0.png)
vene commented 3 years ago

i wonder if we could set up CI jobs to keep the website up to date?

On Mon, May 10, 2021, 20:41 Nikita Titov @.***> wrote:

How index.html looks like now (click to enlarge):

[image: image] https://user-images.githubusercontent.com/25141164/117708173-2662e600-b1d8-11eb-9755-7a7f5e5dc4c0.png

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/scikit-learn-contrib/lightning/pull/172#issuecomment-837122058, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAB3AULXMT4OLXOC7QN4LYLTNASFFANCNFSM44R5WRRA .

StrikerRUS commented 3 years ago

First, conf.py (and other infrastructure scripts) should be updated. Then it will be quite easy to set up GitHub Actions workflow which will update the website with (for example) each commit to master.

StrikerRUS commented 3 years ago

I'll be happy to help with the second step. Speaking about the first one, I'm not sure I'll be able to help because docs generation process looks very custom...

StrikerRUS commented 3 years ago

docs generation process looks very custom...

Oh, wait! Is it embedded very early version of sphinx-gallery package?..

StrikerRUS commented 3 years ago

@vene For the first step, please take a look at #171.