## The problem There are no API doc like below. * https://www.javadoc.io/doc/io.appium/java-client/7.2.0 * https://www.rubydoc.info/github/appium/ruby_lib/Appium/ (Here is available > http://appium.io/docs/en/about-appium/api/ ) If users can browse API doc easily, it will be helpful. ## Candidates * portray: https://github.com/timothycrosley/portray * sphinx + napolean extension ## TODO - [x] Create API doc -> https://ki4070ma.github.io/python-client-sphinx/index.html - [ ] Publish API doc - [ ] Improve API doc
Activity
ki4070ma commentedon Sep 16, 2019
Portray
$portray on_github_pages -mo appium -f)• [Looks good] typing in arguments, description for each argument
• [No care] Exception, Usage, etc
ki4070ma commentedon Sep 28, 2019
Asking timothycrosley/portray#47
ki4070ma commentedon Feb 23, 2020
It's time for trial with sphinx.
mykola-mokhnach commentedon Feb 23, 2020
I would use our python3 branch for docs generation.
ki4070ma commentedon Feb 23, 2020
I'll look into how to change look and feel for each tool.
Samples are here
https://ki4070ma.github.io/python-client-pdoc/
https://ki4070ma.github.io/python-client-sphinx/
mykola-mokhnach commentedon Feb 23, 2020
yep, Sphinx with plugins looks much better
KazuCocoa commentedon Feb 24, 2020
Awesome 🎉 > sphinx
ki4070ma commentedon May 4, 2020
Done https://appium.github.io/python-client-sphinx/