Skip to content
This repository has been archived by the owner on Dec 6, 2023. It is now read-only.

Documentation update #52

Closed
fabianp opened this issue Feb 10, 2016 · 18 comments
Closed

Documentation update #52

fabianp opened this issue Feb 10, 2016 · 18 comments

Comments

@fabianp
Copy link
Member

fabianp commented Feb 10, 2016

Hi @mblondel . Some of the recent additions (such as SAGA) don't show up in the webpage. Would you mind pushing a new version of the doc? (I wouldn't mind doing it myself if it was on github pages)

@mblondel
Copy link
Member

Sure I will do it.

@fabianp
Copy link
Member Author

fabianp commented Feb 11, 2016

Thanks. I am extensively using lightning with some industrial partners and one of the complications we faced was building on Windows. We solved the problem and I managed to do some conda packages (https://anaconda.org/fabianp/lightning). All is fine but it will be difficult to track versions since lightning has always been on v0.1-git. It would help if we start releasing versions from time to time. I am willing to help as much as I can with this. What do you think?

@mblondel
Copy link
Member

With your increased involvement in lightning, it would be nice to move the project to a github organization. We can also move the webpage to github. Regarding releases, I had been avoiding them but if you're willing to do them... :)

Regarding the organization, @vene and I had been discussing the idea of a "scikit-learn-contrib" or "scikit-learn-universe" organization where to put various scikit-learn compatible projects. lightning could possibly be moved there. Or we can create our own organization too.

@fabianp
Copy link
Member Author

fabianp commented Feb 11, 2016

yes to all! As for my involvement, yes, I plan to heavily rely on lightning within the next months, so at least for the close future I will volunteer to maintain it.

I really think releases would positively impact the package quality. However, one problem I foresee is that the pypi page is taken (https://pypi.python.org/pypi/Lightning) :-(

@vene
Copy link
Contributor

vene commented Feb 11, 2016

Very cool, I will try my best to help!

@mblondel
Copy link
Member

I tried to rebuild the docs but the class references don't display properly. I suspect a bug in sphinx-bootstrap-theme, which lightning currently depends on.

https://pypi.python.org/pypi/sphinx-bootstrap-theme/

I guess it's better to work on scikit-learn-contrib's documentation template then use it for lightning.

@fabianp
Copy link
Member Author

fabianp commented Feb 21, 2016

I proposed a fix in PR #56 . The references seem to work fine for me with this patch.

@mblondel
Copy link
Member

Great, thanks! Feel free to create the scikit-learn-contrib.github.io repo and move the documentation in the lightning/ folder.

@fabianp
Copy link
Member Author

fabianp commented Feb 22, 2016

@fabianp fabianp closed this as completed Feb 22, 2016
@mblondel
Copy link
Member

@ogrisel Could you take care of pointing contrib.scikit-learn.org to github? Thanks in advance!

@mblondel
Copy link
Member

@GaelVaroquaux @ogrisel Do you have the privileges to point contrib.scikit-learn.org to github's servers or should I ask Stéfan van der Walt?

@ogrisel
Copy link

ogrisel commented Feb 25, 2016

I think I can do that, let me check.

@ogrisel
Copy link

ogrisel commented Feb 25, 2016

This PR needs to be merged scikit-learn-contrib/scikit-learn-contrib.github.io#1

@mblondel
Copy link
Member

@ogrisel Merged.

By the way, your invitation to scikit-learn-contrib still appears as pending. Did you receive the email? If not I will send it to you again.

@ogrisel
Copy link

ogrisel commented Feb 25, 2016

Joined. The CNAME is in place: http://contrib.scikit-learn.org/lightning/

but there is no top level index: http://contrib.scikit-learn.org/

@mblondel
Copy link
Member

Works on my side too. Thanks a lot!

@mblondel
Copy link
Member

I added a temporary index.html.

@fabianp Please update your blog with lightning's new fancy URL :)

@fabianp
Copy link
Member Author

fabianp commented Feb 25, 2016

cool, done!

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

No branches or pull requests

4 participants