Improve API doc for users #529

Activity

1. ki4070ma

   added

   Documentation

   task

   on May 4, 2020
2. ki4070ma commented on May 4, 2020

   

   ki4070ma

   on May 4, 2020

   Last edited by ki4070ma

   CollaboratorAuthor

   More actions

   Ideas and todo

   • Set language to English
   • Change below repo name to better one (e.g. python-client-doc)
     • https://github.com/appium/python-client-sphinx
   • TypeVar is not user friendly
     • https://appium.github.io/python-client-sphinx/webdriver.common.html#submodules
   • Remaining TODO
     • e.g. https://appium.github.io/python-client-sphinx/webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions
   • Add link to another module
     • https://appium.github.io/python-client-sphinx/webdriver.html#module-webdriver.webdriver
   • Decide if :obj: should be added or not
   • Hide unnecessary modules for users
     • https://appium.github.io/python-client-sphinx/webdriver.html#module-webdriver.mobilecommand
   • Move to readthedocs?
     • (e.g.) https://sphinx-rtd-theme.readthedocs.io/en/stable/
   • Add README.md on github to index.rst
     • https://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rst
3. ki4070ma

   added

   help wanted

   on May 5, 2020