pyspark-ai icon indicating copy to clipboard operation
pyspark-ai copied to clipboard

Published 20 hours ago • verified publisher icon databrickslabs

Build API Documentations

Open gengliangwang opened this issue 1 year ago • 9 comments

Currently, there are no API documents. We should start creating one

gengliangwang avatar Jul 26 '23 22:07 gengliangwang

Hi @gengliangwang I would like to work on this, can you explain it a bit more?

nayan2167 avatar Jul 27 '23 07:07 nayan2167

@nayan2167 Yes it will be a simple Python doc website based on markdown files and our example notebooks.

gengliangwang avatar Aug 08 '23 21:08 gengliangwang

@gengliangwang I am planning to go ahead with mkdocs if it works.

Pranavchiku avatar Aug 12 '23 11:08 Pranavchiku

@Pranavchiku let's go with sphinx

gengliangwang avatar Aug 12 '23 18:08 gengliangwang

Perfect, I will make a draft PR soon.

Pranavchiku avatar Aug 12 '23 18:08 Pranavchiku

If help is needed here I can do it. Recently I added generation of API docs for Quinn PySpark helpers library, so I know how to do it.

It requires the following:

  1. Add some dependencies to pyproject.toml: mkdocstrings-python, mkdocs-gen-files, mkdocs-literate-nav
  2. Add a simple python script like this one to docs
  3. Add a link to this script to mcdocs.yml like it was done here

In runtime it will generate the documentation for all Public API and SUMMARY.md file with right links structure. You can see how it looks like here.

SemyonSinchenko avatar Oct 01 '23 12:10 SemyonSinchenko

May I help somehow here? @Pranavchiku if you do not have time to do it now, just notify me please.

SemyonSinchenko avatar Feb 27 '24 11:02 SemyonSinchenko

@gengliangwang Do you know if anyone is still working on this? Can I help here?

SemyonSinchenko avatar May 29 '24 06:05 SemyonSinchenko

@SemyonSinchenko Please help on this one. Thank you in advance!

gengliangwang avatar May 29 '24 07:05 gengliangwang