search

keras-team / keras-autodoc

Documentation autogeneration utilities.
Apache License 2.0
30 stars 22 forks source link

Populate the README and write a documentation. #36

Closed gabrieldemarmiesse closed 4 years ago

gabrieldemarmiesse commented 4 years ago

The readme is practically empty and we should have a small doc website with a simple tutorial.

The functions to document are:

autogen.DocumentationGenerator, autogen.get_classes, autogen.get_functions, autogen.get_methods.

To get started, you can mimic this https://github.com/keras-team/keras-tuner/tree/master/docs

gabrieldemarmiesse commented 4 years ago

Added a minimal doc #40