Start of docs update (#20)

* Start of docs update Signed-off-by: Nate Koenig <[email protected]> Co-authored-by: Louise Poubel <[email protected]>
gazebosim · May 18, 2020 · b03a73f · b03a73f
1 parent 5019e1b
commit b03a73f
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -115,4 +115,20 @@ ign_create_packages()
 #============================================================================
 # Configure documentation
 #============================================================================
-ign_create_docs()
+configure_file(${CMAKE_SOURCE_DIR}/api.md.in ${CMAKE_BINARY_DIR}/api.md)
+configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials.md)
+
+ign_create_docs(
+  API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
+  TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
+  TAGFILES
+   "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
+   "${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"
+   "${IGNITION-PHYSICS_DOXYGEN_TAGFILE} = ${IGNITION-PHYSICS_API_URL}"
+   "${IGNITION-PLUGIN_DOXYGEN_TAGFILE} = ${IGNITION-PLUGIN_API_URL}"
+   "${IGNITION-TRANSPORT_DOXYGEN_TAGFILE} = ${IGNITION-TRANSPORT_API_URL}"
+   "${IGNITION-SENSORS_DOXYGEN_TAGFILE} = ${IGNITION-SENSORS_API_URL}"
+   "${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}"
+   "${IGNITION-GAZEBO_DOXYGEN_TAGFILE} = ${IGNITION-GAZEBO_API_URL}"
+   "${IGNITION-GUI_DOXYGEN_TAGFILE} = ${IGNITION-GUI_API_URL}"
+)
diff --git a/api.md.in b/api.md.in
@@ -0,0 +1,10 @@
+## Ignition @IGN_DESIGNATION_CAP@
+
+Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of libraries
+designed to rapidly develop robot and simulation applications. 
+
+## License
+
+The code associated with this documentation is licensed under an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+This documentation is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
diff --git a/tutorials.md.in b/tutorials.md.in
@@ -0,0 +1,13 @@
+\page tutorials Tutorials
+
+Welcome to the Ignition @IGN_DESIGNATION_CAP@ tutorials. These tutorials
+will guide you through the process of understanding the capabilities of the
+Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively.
+
+**Tutorials**
+
+## License
+
+The code associated with this documentation is licensed under an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+This documentation is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).