diff --git a/src/python/docs/conf.py.in b/src/python/docs/conf.py.in index b95c88a..344abe1 100644 --- a/src/python/docs/conf.py.in +++ b/src/python/docs/conf.py.in @@ -47,7 +47,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'pymraa' +project = 'mraa' copyright = '2014, Intel Corporation' # The version info for the project you're documenting, acts as replacement for @@ -180,7 +180,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pymraadoc' +htmlhelp_basename = 'mraadoc' # -- Options for LaTeX output --------------------------------------------- diff --git a/src/python/docs/example.rst b/src/python/docs/example.rst index da74d0e..1dbaea1 100644 --- a/src/python/docs/example.rst +++ b/src/python/docs/example.rst @@ -1,16 +1,16 @@ ####### Example ####### -Here are some examples of how to use pymraa, common convention is to import pymraa as mraa to keep it short but feel free to import it globally! +Here are some examples of how to use mraa, common convention is to import mraa as mraa to keep it short but feel free to import it globally! Hello GPIO ========== -Here is the simplest Gpio program in pymraa. +Here is the simplest Gpio program in mraa. .. literalinclude:: ../../../examples/python/hello_gpio.py - :prepend: import pymraa - :start-after: import pymraa + :prepend: import mraa + :start-after: import mraa GPIO Interupt (isr) =================== @@ -20,6 +20,6 @@ The GPIO module allows you to set an interupt on a GPIO. This interupt is contro **Note:** Galileo Gen1 only supports EDGE_BOTH .. literalinclude:: ../../../examples/python/hello_isr.py - :prepend: import pymraa as mraa - :start-after: import pymraa as mraa + :prepend: import mraa + :start-after: import mraa diff --git a/src/python/docs/index.rst b/src/python/docs/index.rst index 9caf879..b0443de 100644 --- a/src/python/docs/index.rst +++ b/src/python/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Pymraa's documentation! +Welcome to mraa's documentation! ============================= Contents: @@ -11,7 +11,7 @@ Contents: .. toctree:: :maxdepth: 2 - pymraa + mraa example diff --git a/src/python/docs/pymraa.rst b/src/python/docs/mraa.rst similarity index 65% rename from src/python/docs/pymraa.rst rename to src/python/docs/mraa.rst index 1b6c011..8e442e1 100644 --- a/src/python/docs/pymraa.rst +++ b/src/python/docs/mraa.rst @@ -1,7 +1,7 @@ -pymraa module +mraa module ============ -.. automodule:: pymraa +.. automodule:: mraa :members: :undoc-members: :show-inheritance: