Improve API doc for users

[ki4070ma]

The problem

Just published API doc. https://appium.github.io/python-client-sphinx/

However, it is just first revision and could be more user friendly.

References

• https://www.sphinx-doc.org/en/stable/examples.html
• https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html#sphinxcontrib.napoleon.Config

[ki4070ma]

Ideas and todo

• [x] 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