From cc6f192b8e04f2fb800fa4893370de7a574c5b1f Mon Sep 17 00:00:00 2001 From: Artem30801 Date: Tue, 20 Oct 2020 01:20:40 +0300 Subject: [PATCH] docs: changed api docs summary --- builder/builder-tools/generate_api_docs.py | 6 +++++- docs/en/api/SUMMARY.md | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/builder/builder-tools/generate_api_docs.py b/builder/builder-tools/generate_api_docs.py index 601cb37..e5a4618 100644 --- a/builder/builder-tools/generate_api_docs.py +++ b/builder/builder-tools/generate_api_docs.py @@ -3,6 +3,7 @@ import sys import pydoc import logging + class DocsGenerator: def __init__(self, module_header="# Module {}", @@ -134,6 +135,9 @@ if __name__ == '__main__': "drone.modules.client_core", ] - gen = DocsGenerator() + gen = DocsGenerator(contents_table_header="# API documentation\n" + "`clever-show` can be modified or used as set of modules to repurpose the software or implement different behaviors, expand functionality.\n" + "> Please note, following documentation files were automatically generated from the source code\n" + "## Table of contents") doc_path = os.path.realpath(os.path.join(current_dir, os.pardir, os.pardir, "docs", "en", "api")) gen.generate_docs(modules_list, doc_path) diff --git a/docs/en/api/SUMMARY.md b/docs/en/api/SUMMARY.md index 53d0479..64a30c5 100644 --- a/docs/en/api/SUMMARY.md +++ b/docs/en/api/SUMMARY.md @@ -1,4 +1,5 @@ # API documentation +`clever-show` can be modified or used as set of modules to repurpose the software or implement different behaviors, expand functionality. > Please note, following documentation files were automatically generated from the source code ## Table of contents * [messaging](messaging.md)