mithril-security / blindai

Confidential AI deployment with secure enclaves :lock:
https://www.mithrilsecurity.io/
Apache License 2.0
500 stars 35 forks source link

Automate the generation of the client API reference #51

Closed CerineBnsd closed 2 years ago

CerineBnsd commented 2 years ago

Description

The client API reference should be automatically generated from docstrings in the package files.

Why this modification is needed?

It's not practicle to rewrite it everytime we do changes, it can also have a better look this way.

What documents need to be updated

Additional Information

The existing toole may generate the documentatoin in form of HTML pages => A website, should we be restricted to the once who produce markdown files instead? So that they can always be included directly in the gitbook, or we can have a website that will be linked there?

Checklist

JoFrost commented 2 years ago

Bumping this issue, as it will become a priority with the future releases

JoFrost commented 2 years ago

Yep!