diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..fc5f205 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,32 @@ +Developer Interface +******************* + +This part of the documentation describes the interfaces for using FoxPuppet. + +FoxPuppet +--------- + +.. py:module:: foxpuppet.foxpuppet + +.. autoclass:: FoxPuppet + + +Windows +------- + +This module contains all of the window types as well as the window manager. + +Window Manager +============== + +.. py:module:: foxpuppet.windows + +.. autoclass:: WindowManager + +Browser Window +============== + +.. py:module:: foxpuppet.windows.browser.window + +.. autoclass:: BrowserWindow + :inherited-members: diff --git a/docs/conf.py b/docs/conf.py index 8e37f47..6efd481 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,9 +17,9 @@ # 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('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ @@ -31,9 +31,16 @@ # 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', +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', 'sphinx.ext.todo', - 'sphinx.ext.viewcode'] + ] + +# intersphinx mappings +intersphinx_mapping = { + 'selenium': ('http://seleniumhq.github.io/selenium/docs/api/py/', None)} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/index.rst b/docs/index.rst index 58c36e6..b89eaab 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,3 +11,4 @@ FoxPuppet is a library for automating user interactions in `Firefox