diff --git a/PythonClient/docs/conf.py b/PythonClient/docs/conf.py index 5a5361e8c9..e7bfe2273d 100644 --- a/PythonClient/docs/conf.py +++ b/PythonClient/docs/conf.py @@ -49,6 +49,7 @@ 'sphinx.ext.mathjax', 'sphinx.ext.coverage', 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', 'sphinx_rtd_theme' ] diff --git a/PythonClient/docs/index.rst b/PythonClient/docs/index.rst index 9aed7a55be..c256e3fcd4 100644 --- a/PythonClient/docs/index.rst +++ b/PythonClient/docs/index.rst @@ -5,7 +5,7 @@ airsim ========================================= -This page documents `airsim`_, the python package to be used for `Game of Drones: A NeurIPS 2019 Competition`_. +This page documents `airsim`_, the python package to be used for `Microsoft AirSim`_. .. _`airsim`: https://pypi.org/project/airsim/ .. _`Microsoft AirSim`: https://github.com/microsoft/AirSim @@ -16,13 +16,27 @@ This page documents `airsim`_, the python package to be used for `Game of Drones * :ref:`genindex` * :ref:`modindex` +.. autoclass:: airsim.client.VehicleClient + :members: + :undoc-members: + :show-inheritance: + .. autoclass:: airsim.client.MultirotorClient :members: + :undoc-members: + :show-inheritance: + +.. autoclass:: airsim.client.CarClient + :members: + :undoc-members: + :show-inheritance: .. automodule:: airsim.types :members: + :undoc-members: :show-inheritance: .. automodule:: airsim.utils - :members: + :members: + :undoc-members: :show-inheritance: \ No newline at end of file