Hi ,
I am trying to change the auto generated documentation files in
scikit-learn/doc/modules/generated/ . Suppose I have added extra
functionality to `sklearn.ensemble.GradientBoostingClassifier` . The rst
file for that documentation
is sklearn.ensemble.GradientBoostingClassifier.rst which in
scikit-learn/doc/modules/generated/. The content of the file is as follows
:mod:`sklearn.ensemble`.GradientBoostingClassifier
> =========================================================
> .. currentmodule:: sklearn.ensemble
> .. autoclass:: GradientBoostingClassifier
>
> .. automethod:: __init__
>
I suppose the relevant information for the html document is taken from the
doc string in the `GradientBoostingClassifier`. How does this data renders
into a html document. The doc string does not contain all the information
about the functions in that class. But generated html document contains all
information including the function descriptions in that class. Can someone
explain how does this work?
(I am using make doc to build the the documentation pages after changing)
Best regards,
Maheshakya
--
Undergraduate,
Department of Computer Science and Engineering,
Faculty of Engineering.
University of Moratuwa,
Sri Lanka
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/13534_NeoTech
_______________________________________________
Scikit-learn-general mailing list
Scikit-learn-general@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
