doc: Add script to generate sphinx doc

.gitignore

@@ -5,6 +5,7 @@
 *._*
 *.log
 *.log.*
+_*/
 
 *.pyc
 *.egg-info
@@ -23,4 +24,4 @@ __pycache__
 venv*
 .tox
 
-Pipfile.lock
+Pipfile.lock

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,21 @@
+### How to generate doc
+
+```bash
+$cd python-client
+$sphinx-apidoc -F -o docs/ appium/webdriver
+$cd docs
+$make html
+```
+
+### How to check generated doc
+
+```bash
+$cd python-client/docs/_build/html
+$python -m http.server 1234
+```
+
+Access to `http://localhost:1234` on web browser
+
+
+### Deploy generated doc
+To be updated

docs/conf.py

@@ -0,0 +1,59 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../appium'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'python_client_doc'
+copyright = '2020, Appium'
+author = 'Appium'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.napoleon',
+ 'sphinx.ext.githubpages'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,21 @@
+.. webdriver documentation master file, created by
+ sphinx-quickstart on Mon Feb 24 15:27:21 2020.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to webdriver's documentation!
+=====================================
+
+.. toctree::
+ :maxdepth: 4
+ :caption: Contents:
+
+ webdriver
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+echo.
+echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+echo.installed, then set the SPHINXBUILD environment variable to point
+echo.to the full path of the 'sphinx-build' executable. Alternatively you
+echo.may add the Sphinx directory to PATH.
+echo.
+echo.If you don't have Sphinx installed, grab it from
+echo.http://sphinx-doc.org/
+exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/webdriver.common.rst

@@ -0,0 +1,38 @@
+webdriver.common package
+========================
+
+Submodules
+----------
+
+webdriver.common.mobileby module
+--------------------------------
+
+.. automodule:: webdriver.common.mobileby
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.common.multi\_action module
+-------------------------------------
+
+.. automodule:: webdriver.common.multi_action
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.common.touch\_action module
+-------------------------------------
+
+.. automodule:: webdriver.common.touch_action
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: webdriver.common
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/webdriver.extensions.android.rst

@@ -0,0 +1,94 @@
+webdriver.extensions.android package
+====================================
+
+Submodules
+----------
+
+webdriver.extensions.android.activities module
+----------------------------------------------
+
+.. automodule:: webdriver.extensions.android.activities
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.common module
+------------------------------------------
+
+.. automodule:: webdriver.extensions.android.common
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.display module
+-------------------------------------------
+
+.. automodule:: webdriver.extensions.android.display
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.gsm module
+---------------------------------------
+
+.. automodule:: webdriver.extensions.android.gsm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.nativekey module
+---------------------------------------------
+
+.. automodule:: webdriver.extensions.android.nativekey
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.network module
+-------------------------------------------
+
+.. automodule:: webdriver.extensions.android.network
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.performance module
+-----------------------------------------------
+
+.. automodule:: webdriver.extensions.android.performance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.power module
+-----------------------------------------
+
+.. automodule:: webdriver.extensions.android.power
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.sms module
+---------------------------------------
+
+.. automodule:: webdriver.extensions.android.sms
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+webdriver.extensions.android.system\_bars module
+------------------------------------------------
+
+.. automodule:: webdriver.extensions.android.system_bars
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: webdriver.extensions.android
+ :members:
+ :undoc-members:
+ :show-inheritance: