From 89c92397987cc97da3b22eb92b827ef77e256225 Mon Sep 17 00:00:00 2001 From: sisinty sasmita patra Date: Mon, 18 May 2015 09:27:00 -0700 Subject: [PATCH] sphinx: updated index.rst file added content from readme.md into index.rst file. Signed-off-by: Sisinty Sasmita Patra Signed-off-by: Mihai Tudor Panu --- doxy/index.rst | 57 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 44 insertions(+), 13 deletions(-) diff --git a/doxy/index.rst b/doxy/index.rst index 9eab293c..45cdba5d 100644 --- a/doxy/index.rst +++ b/doxy/index.rst @@ -1,36 +1,67 @@ -.. UPM Python documentation master file, created by +.. UPM Python documentation master file, created by Sisinty Sasmita Patra UPM Team on Thu May 14 15:58:46 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to UPM Python documentation! +**Welcome to UPM Python documentation!** ========================================= .. include:: ../../README.md :start-after: ============== :end-before: ### Example -.. include:: ../../README.md - :start-after: configure your project. - :end-before: C/C++ API +``Building UPM`` +################ -List of available sensors drivers: +For building UPM, please follow this `link `_. + +``Making your own UPM Module`` +############################## + +This `link `_ has more information on making a new UPM module. + +There is also an example available for max31855 `sensor `_. + +``Naming Conventions and rules for new UPM Contributions`` +########################################################## + +Before you begin development, please take a look at our naming `conventions `_. + +Also, please read the guidelines for contributions to `UPM `_. + +Don't forget to check the documentation `section `_. + +.. note:: + + * Make sure you add yourself as an author on every new code file submitted. + * If you are providing a fix with significant changes, feel free to add yourself as a contributor. + * Signing-off your commits is mandatory. + +``List of available sensors drivers`` +###################################### .. toctree:: :maxdepth: 2 modules -Limitations and List of Changes -================== +``C/C++ API Documentation`` +########################### -This is the Sphinx generated documentation for UPM... +The C/C++ API documentation is available `here `_. -.. include:: ../../docs/knownlimitations.md -.. include:: ../../docs/changelog.md +``Version`` +########### -Indices and tables -================== +For Version Changelog, please see `here `_. + +``Limitations and List of Changes`` +################################### + +For List of Known Limitations, please see `here `_. + +``Indices and tables`` +###################### * :ref:`genindex` * :ref:`modindex`