docs: fix warnings in doc creation

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

diff --git a/docs/contributions.md b/docs/contributions.md
index faf6416..934df08 100644 (file)
--- a/docs/contributions.md
+++ b/docs/contributions.md
@@ -9,7 +9,7 @@ Here are the rules of contribution:
   is MIT but any permissive license is fine. Please consider that people using
   UPM may want to write proprietary programs with your sensors so we like to
   avoid GPL. (LGPL is fine). If your license is not MIT please include a
-  LICENSE file in src/<mymodule>/
+  LICENSE file in src/mymodule/
 - Please test your module builds before contributing and make sure it works on
   the latest version of mraa. If you tested on a specific board/platform please
   tell us what this was in your PR.

diff --git a/docs/max31855.md b/docs/max31855.md
index 66ee214..564855b 100644 (file)
--- a/docs/max31855.md
+++ b/docs/max31855.md
@@ -93,5 +93,5 @@ target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
 ~~~~~~~~~~~
 
 Note you dont have to rebuild everything, cmake keeps target lists so if you
-named your example target <modulename>-example you can simply do make
+named your example target modulename-example you can simply do make
 max31855-example and both the library & example will build.

diff --git a/docs/porting.md b/docs/porting.md
index d9f7c89..ebf9204 100644 (file)
--- a/docs/porting.md
+++ b/docs/porting.md
@@ -9,13 +9,13 @@ example is explained in detail on @ref max31855
 ### Adding a new module to UPM
 
 1. Choose a name for your module (see @ref naming)
-2. Make a new folder in src/<modulename>
-3. Create a CMakeLists.txt file inside src/<modulename>
+2. Make a new folder in src/modulename
+3. Create a CMakeLists.txt file inside src/modulename
 
 ### CmakeLists.txt
 
-By default you need a header called <modulename>.h and a C++ file called
-<modulename>.cxx. You can have multiple headers and source files. Only public
+By default you need a header called modulename.h and a C++ file called
+modulename.cxx. You can have multiple headers and source files. Only public
 headers need to be added to module_h and all source files need to be in
 module_src.
 
@@ -60,6 +60,6 @@ The last step is when you're happy with your module and it works send us a pull
 request! We'd love to include your sensor in our repository.
 
 If you don't like github you can also send brendan.le.foll@intel.com a git
-formatted patch if your sensor. More details are on @ref contributing and on
+formatted patch if your sensor. More details are on @ref contributions and on
 https://help.github.com/articles/creating-a-pull-request