CopterExpress/clever-show
1
0
Fork 0
mirror of https://github.com/CopterExpress/clever-show.git synced 2026-05-26 07:07:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: changed api docs summary

Browse Source
This commit is contained in:
Artem30801
2020-10-20 01:20:40 +03:00
parent 69ab125011
commit cc6f192b8e
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
builder/builder-tools/generate_api_docs.py
View File

@@ -3,6 +3,7 @@ import sys
import pydoc import pydoc
import logging import logging
class DocsGenerator: class DocsGenerator:
def __init__(self, def __init__(self,
module_header="# Module {}", module_header="# Module {}",
@@ -134,6 +135,9 @@ if __name__ == '__main__':
"drone.modules.client_core", "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")) doc_path = os.path.realpath(os.path.join(current_dir, os.pardir, os.pardir, "docs", "en", "api"))
gen.generate_docs(modules_list, doc_path) gen.generate_docs(modules_list, doc_path)

1
docs/en/api/SUMMARY.md
View File

@@ -1,4 +1,5 @@
# API documentation # API documentation
`clever-show` can be modified or used as set of modules to repurpose the software or implement different behaviors, expand functionality. `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 > Please note, following documentation files were automatically generated from the source code