[source]

DocumentationGenerator class

keras_autodoc.DocumentationGenerator(
    pages: Dict[str, list] = None,
    project_url: Union[str, Dict[str, str]] = None,
    template_dir=None,
    examples_dir=None,
)

Generates the documentation.

Arguments

• pages: A dictionary. The keys are the files' paths, the values are lists of strings, functions /classes / methods names with dotted access to the object. For example, pages = {'my_file.md': ['keras.layers.Dense']} is valid.
• project_url: The url pointing to the module directory of your project on GitHub. This will be used to make a [Sources] link.
• template_dir: Where to put the markdown files which will be copied and filled in the destination directory. You should put files like index.md inside. If you want a markdown file to be filled with the docstring of a function, use the {{autogenerated}} tag inside, and then add the markdown file to the pages dictionary.
• example_dir: Where you store examples in your project. Usually standalone files with a markdown docstring at the top. Will be inserted in the docs.

---

[source]

generate method

DocumentationGenerator.generate(dest_dir)

Generate the docs.

Arguments

• dest_dir: Where to put the resulting markdown files.

---