-
Notifications
You must be signed in to change notification settings - Fork 32
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
[MRG] Documentation: added sphinx support and some first docstrings #54
Conversation
Codecov Report
@@ Coverage Diff @@
## master #54 +/- ##
=======================================
Coverage 95.39% 95.39%
=======================================
Files 9 9
Lines 891 891
=======================================
Hits 850 850
Misses 41 41
Continue to review full report at Codecov.
|
I am fine with readthedoc. |
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.
+1 for merging quickly and improving the doc and docstring in later PR once it's easy to read the doc online.
Ok I'll add some docstrings for the grower as well, and merge. Do we want to spin up a Circle CI that build the docs for each PR like in scikit-learn? Unfortunately RTD does not support it at the moment readthedocs/readthedocs.org#1340 |
I think it's fine just to build a "dev" version of the doc from the master and a "stable" version of the doc from the stable release when we make one. |
Ok. Then I'm not sure what you mean by once it's easy to read the doc online |
Merged @ogrisel , the docs are here: https://pygbm.readthedocs.io/en/latest/ I flattened everything in As I don't have admin rights on the github repo, RTD couldn't set up the hooks so new commits won't trigger the doc buildings. I added you as admin on RTD maybe that will fix it. |
This PR adds a
doc
directory, setups sphinx (separatebuild
andsource
directories) withsphinx-quickstart
and adds some first docstring proposals for the estimators.Should we set up something on ReadTheDocs or equivalent?
I set up the RTD theme because I like it but I'm open to anything of course.