Add an API for all aerostack2

RPS98 · RPS98 · commit 1ff5bc105b68 · 2024-04-22T13:04:12.000+02:00
diff --git a/.github/workflows/example-sphinx.yml b/.github/workflows/example-sphinx.yml
@@ -29,7 +29,7 @@ jobs:
     - name: Build and Commit
       uses: aerostack2/pages@v2
       with:
-        aerostack2_modules: as2_python_api, as2_core
+        aerostack2_modules: aerostack2
         sphinx_version: 7.2.6
     - name: Push changes
       uses: ad-m/github-push-action@master
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 .vscode/
 _build/
+build/
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ This is to be improved in later versions.
 ## Adding a C++ project to docs
 
 To add a C++ module to the web, follow these steps:
-- Grab from this repository https://github.com/aerostack2/aerostack2.github.io the doxygen.dox file inside the doxygen_template/ folder and put it into the C++ project root folder. 
+- Grab from this repository https://github.com/aerostack2/aerostack2.github.io the Doxyfile file inside the doxygen_template/ folder and put it into the C++ project root folder. 
 - Modify first two lines of this file, substituting as2_package for the name of your C++ project.
 ```
   PROJECT_NAME = as2_cpp_package
diff --git a/docs/_01_aerostack2_concepts/motion_controller/index.rst b/docs/_01_aerostack2_concepts/motion_controller/index.rst
@@ -63,7 +63,7 @@ Also, the frame of each command is specified in the header of the message, allow
 .. _as2_concepts_motion_controller_control_modes_output:
 
 Output Control Modes
-===================
+====================
 
 Aerostack2 Motion Controller supports the following ouput control modes:
 
diff --git a/docs/_06_user_interfaces/index.rst b/docs/_06_user_interfaces/index.rst
@@ -12,18 +12,7 @@ Aerostack2 provides with a series of user interfaces. These interfaces includes
    _keyboard_teleoperation/index.rst
    _alphanumeric_viewer/index.rst
 
-.. _user_interfaces_behavior_tree:
-
--------------
-Behavior Tree
--------------
-
-TBD: User Manual
-
-.. _user_interfaces_web_gui:
-
--------
-Web Gui
--------
-
-TBD: User Manual
+..
+  TBD: Add the following interfaces
+  Behavior Tree
+  Web-GUI
diff --git a/docs/_07_python_api/index.rst b/docs/_07_python_api/index.rst
diff --git a/docs/_08_ros2_common_interfaces/index.rst b/docs/_08_ros2_common_interfaces/index.rst
@@ -16,12 +16,12 @@ This page describes common ROS 2 interfaces for inter-process communication used
    state_estimator/index.rst
    behaviors/index.rst
 
-Also, Aerostack2 provides a set of ROS 2 messages in the package `as2_msgs <ros2_common_interfaces_as2_msgs>`_.
-
-.. toctree::
-   :maxdepth: 1
-
-   as2_msgs/index.rst
+.. 
+  TBD: Add as2_msgs documentation
+  Also, Aerostack2 provides a set of ROS 2 messages in the package `as2_msgs <ros2_common_interfaces_as2_msgs>`_.
+  .. toctree::
+    :maxdepth: 1
+    as2_msgs/index.rst
 
 
 
diff --git a/docs/_09_development/_api_documentation/index.rst b/docs/_09_development/_api_documentation/index.rst
@@ -7,57 +7,24 @@
 API Documentation
 =================
 
-TDB
+.. _development_guide_api_aerostack2:
 
-
-
-.. _development_guide_api_as2_core:
-
---------
-AS2 Core
---------
-
-Code
-####
+----------
+Aerostack2
+----------
 
 .. toctree::
    :maxdepth: 2
 
-   as2_core/docs/index.rst
-
-.. _development_guide_api_as2_msgs:
-
---------
-AS2 Msgs
---------
-
-TDB
-
-
-.. _development_guide_api_as2_motion_controller:
-
----------------------
-AS2 Motion Controller
----------------------
+   aerostack2/docs/index.rst
 
-TDB
+.. _development_guide_api_python_api:
 
+----------
+Python API
+----------
 
+.. toctree::
+   :maxdepth: 2
 
-.. _development_guide_api_as2_state_estimator:
-
--------------------
-AS2 State Estimator
--------------------
-
-TDB
-
-
-
-.. _development_guide_api_as2_behavior:
-
-------------
-AS2 Behavior
-------------
-
-TDB
+   temp_ws/src/as2_python_api/docs/source/index.rst
diff --git a/docs/_12_citations/index.rst b/docs/_12_citations/index.rst
@@ -4,4 +4,7 @@
 Citations
 =========
 
-TBD: Aerostack2 paper comming soon
+If you use the code, please cite\:
+
+* \M. Fernandez-Cortizas, M. Molina, P. Arias-Perez, R. Perez-Segui, D. Perez-Saura, and P. Campoy, 2023,  `"Aerostack2: A software framework for developing multi-robot aerial systems" <https://arxiv.org/abs/2303.18237>`_ , ArXiv DOI 2303.18237.
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -37,7 +37,7 @@
 # -- General configuration ---------------------------------------------------
 
 breathe_projects = {
-    "as2_core": "./_09_development/_api_documentation/as2_core/doxygen/xml"
+    "aerostack2": "./_09_development/_api_documentation/aerostack2/doxygen/xml"
 }
 
 # Add any Sphinx extension module names here, as strings. They can be
diff --git a/docs/index.rst b/docs/index.rst
@@ -68,10 +68,13 @@ If you use the code in the academic context, please cite\:
    _04_robot_behaviors/index.rst
    _05_as2_plugins/index.rst
    _06_user_interfaces/index.rst
-   _07_python_api/index.rst
    _08_ros2_common_interfaces/index.rst
    _09_development/index.rst
-   _10_roadmaps/index.rst
    _11_license/index.rst
    _12_citations/index.rst
    _13_about_and_contact/index.rst
+
+.. 
+  TODO:
+  _07_python_api/index.rst
+  _10_roadmaps/index.rst
diff --git a/doxygen_template/Doxyfile b/doxygen_template/Doxyfile
diff --git a/table_of_contents.md b/table_of_contents.md
@@ -7,13 +7,11 @@ Pages:
 04. Robot Behaviors
 05. AS2 Plugins
 06. User Interfaces
-07. Python API
-08. ROS 2 Common interfaces
-09. Development
-10. Roadmaps
-11. License Agreement: 3-Clause BSD License
-12. Citations
-13. About and Contact 
+07. ROS 2 Common interfaces
+08. Development
+09. License Agreement: 3-Clause BSD License
+10. Citations
+11. About and Contact 
 
 
 Extended Table of Contents:
@@ -95,8 +93,7 @@ Extended Table of Contents:
     - Keyboard Teleoperation
     - Alphanumeric Viewer
     - Web Gui
-07. Python API
-08. ROS 2 Common interfaces
+07. ROS 2 Common interfaces
     - Aerial Platform
         - Topics
         - Services
@@ -109,7 +106,7 @@ Extended Table of Contents:
         - Actions
     - AS2 Msgs
     - Using AS2 Interfaces
-09. Development
+08. Development
     - Command Line Interface (CLI)
     - Tutorials
         - Writing a New Aerial Platform
@@ -176,7 +173,6 @@ Extended Table of Contents:
         - AS2 State Estimator
         - AS2 Behavior
 
-10. Roadmaps
-11. License Agreement: 3-Clause BSD License
-12. Citations
-13. About and Contact
+09. License Agreement: 3-Clause BSD License
+10. Citations
+11. About and Contact

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`.vscode/`
`2`	`2`	`_build/`
	`3`	`+build/`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`# -- General configuration ---------------------------------------------------`
`38`	`38`
`39`	`39`	`breathe_projects = {`
`40`		`- "as2_core": "./_09_development/_api_documentation/as2_core/doxygen/xml"`
	`40`	`+ "aerostack2": "./_09_development/_api_documentation/aerostack2/doxygen/xml"`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`# Add any Sphinx extension module names here, as strings. They can be`