Package and API Docs building & Hosting

[amjadraza]

Feature: Enhancement

Adding Documentation and API guide. I propose two frameworks

A. Using Pythonic Sphnix Framework and deploying on the readthedocs server

1. Open Source, comes with many themes / templates
2. Extensively used for Python Packages e.g LangChain API is using the readthedocs template of Sphnix
3. Have support of .rst , .mk and much more formats

B. Using mkdocs framework

1. Light framework based on Python, Pandas-ai is using this
2. Support MarkDown files
3. Comes with material and readthedocs templates.

C. Using Vercel Documentations

1. https://nextra-docs-template.vercel.app/
2. API reference guide still using Sphnix
3. LangChain is using this platform too

DocString Styles: Among many docstrings styles, Google Style is very famous and easy to implement.

It is important to decide on Documentation Especially Docstrings early on to generate the API reference Guide professionally. Re-Factoring a huge code base with Docstring is a huge job.

I can contribute to this feature.

[amjadraza]

@taranjeet @deshraj What do you guys say?