API Document¶
-
class
plate.api_document.
APIDocument
(config=None)¶ Making API Document
-
create_api_docs
()¶ Convert API Document to HTML.
Returns: OrderedDict
instance.
-
highlight_syntax
(soup)¶ Highlight code syntax.
Parameters: soup – bs4 instance Returns: bs4 instance
-
modify_html
(soup)¶ Modify HTML
Parameters: soup – bs4 instance Returns: HTML
-
read_index
(index_file_path)¶ Read API Document index file such as
index.json
.Parameters: index_file_path – index file path Returns: JSON of index file( index.json
)
-
total_reload_docs
()¶ Reload all API Document files.
-