lbr-stack · mhubii · May 5, 2023 · Apr 25, 2023 · Apr 25, 2023 · Apr 25, 2023
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -13,7 +13,7 @@ build:
   jobs:
     post_install:
       - wget https://raw.githubusercontent.com/KCL-BMEIS/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos.yml
-      - vcs import < repos.yml
+      - vcs import doc/source < repos.yml
 
 python:
    install:

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # lbr_fri_ros2_stack_doc
 [![Documentation Status](https://readthedocs.org/projects/lbr-fri-ros2-stack-doc/badge/?version=humble)](https://lbr-fri-ros2-stack-doc.readthedocs.io/en/humble/?badge=humble)
 
-This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack).
+This repository holds the documentation for the [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack).
 
 ## Acknowledgements
 <img src="https://www.kcl.ac.uk/newimages/Wellcome-EPSRC-Centre-medical-engineering-logo.xa827df3f.JPG?f=webp" alt="wellcome" height="45" width="65" align="left">

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -3,16 +3,16 @@
 
 doxy_list = [
     "fri.Doxyfile",
-    "lbr_fri_ros2.Doxyfile", # lbr_fri_ros2.Doxyfile requires tagfile of fri.Doxyfile
+    "lbr_fri_ros2.Doxyfile",  # lbr_fri_ros2.Doxyfile requires tagfile of fri.Doxyfile
 ]
 
 for doxyfile in doxy_list:
     doxyfile_name = doxyfile.split(".")[0]
 
     # generate doxygen
-    pathlib.Path(f"docs/doxygen/{doxyfile_name}").mkdir(
-        parents=True
-    )  # this is the doxygen OUTPUT_DIRECTORY
+    path = pathlib.Path(f"docs/doxygen/{doxyfile_name}")
+    if not path.exists():
+        path.mkdir(parents=True)  # this is the doxygen OUTPUT_DIRECTORY
     subprocess.run(f"doxygen {doxyfile}", shell=True)
 
     # convert doxygen to sphinx, source and build directory need
@@ -29,19 +29,48 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "lbr_fri_ros2"
+project = "lbr_fri_ros2_stack"
 copyright = "2023, mhubii"
 author = "mhubii"
 release = "1.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx_mdinclude"]
+extensions = [
+    "sphinx_mdinclude",
+    "sphinx_copybutton",
+    "sphinx.ext.autosectionlabel",
+    "sphinx_panels",
+    "sphinxcontrib.images",
+    "sphinxcontrib.doxylink",
+]
 
 templates_path = ["_templates"]
-exclude_patterns = []
+exclude_patterns = ["links.rst"]
+
+# Doxylink
+doxygen_root = "docs/doxygen"
+doxylink = {
+    "fri": (
+        f"{doxygen_root}/fri/html/tagfile.xml",
+        f"{doxygen_root}/fri/html",
+    ),
+    "lbr_fri_ros2": (
+        f"{doxygen_root}/lbr_fri_ros2/html/tagfile.xml",
+        f"{doxygen_root}/lbr_fri_ros2/html",
+    ),
+}
+
+# Make rst_epilog a variable, so you can add other epilog parts to it
+rst_epilog = ""
+
+# Read link all targets from file
+with open("docs/links.rst") as f:
+    rst_epilog += f.read()
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst
@@ -1,13 +1,15 @@
 Additional Resources
 ====================
-**Note**: These resources may **not** be re-distributed but are accesible on `KUKA Xpert <https://xpert.kuka.com>`_.
+.. note::
+    These resources may **not** be re-distributed but are accesible on `KUKA Xpert`_.
 
-For internal use only, below are links to the school's `Sharepoint <https://emckclac.sharepoint.com>`_:
+For internal use only, below are links to the King's `King's Sharepoint`_:
 
 * Hardware:
-    * `LBR Med Quickstart <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/LBR_Med_Quick_Start_en.pdf>`_
-    * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_LBR_Med_en.pdf>`_
-    * `KUKA Sunrise Cabinet Med, Instructions for Use <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_KUKA_Sunrise_Cabinet_Med_en.pdf>`_
+    * `LBR Med Quickstart`_
+    * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use`_
+    * `KUKA Sunrise Cabinet Med, Instructions for Use`_
 * Software:
-    * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_KUKA_SunriseOS_Med_115_en.pdf>`_
-    * `KUKA Sunrise.FRI 1.15 <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/KUKA_SunriseFRI_115_en.pdf>`_
+    * `KUKA Sunrise Workbench 1.15`_
+    * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators`_
+    * `KUKA Sunrise.FRI 1.15`_
diff --git a/doc/source/docs/demos.rst b/doc/source/docs/demos.rst
diff --git a/doc/source/docs/links.rst b/doc/source/docs/links.rst
@@ -0,0 +1,8 @@
+.. _KUKA Xpert: https://xpert.kuka.com/
+.. _King's SharePoint: https://emckclac.sharepoint.com/
+.. _LBR Med Quickstart: https://emckclac.sharepoint.com/:b:/s/MT-BMEIS-ALL/ESJdZZ3HRgRHswsPvH2VXVkBuKXnA6rBdqV9Drk0DME-XQ?e=5k20eS
+.. _LBR Med 7 R800, LBR Med 14 R820, Insructions for Use: https://emckclac.sharepoint.com/:b:/s/MT-BMEIS-ALL/EZ5WWlY6vfJPnlChRLe7zQMBxF6v85rGcjHiKIQMBOFmmA?e=e0qgA8
+.. _KUKA Sunrise Cabinet Med, Instructions for Use: https://emckclac.sharepoint.com/:b:/s/MT-BMEIS-ALL/ETqh57k0rZVKj2f1wlqGSPEB_3JZBIxBHTCvmyCD6cLWgg?e=A0SRh4
+.. _KUKA Sunrise Workbench 1.15: https://emckclac.sharepoint.com/:u:/s/MT-BMEIS-ALL/EeTzbmK3K-BEp-TlTQvwJn0BSCVuxR9tx1Zb2Pc7WLDz_A?e=Ifn8HI
+.. _KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators: https://emckclac.sharepoint.com/:b:/s/MT-BMEIS-ALL/EdwsKu2TuW5DmXfJCdSsnrkBNH-wFXcOMTsOjUpFZvwHlA?e=cVtN7n
+.. _KUKA Sunrise.FRI 1.15: https://emckclac.sharepoint.com/:b:/s/MT-BMEIS-ALL/EdN6Un5WWZ1ImZu8pgqUJwoBNaJ_3Z6Fhw_zEEn6HaU4gA?e=QQwlOB
diff --git a/doc/source/docs/real_robot_setup.rst b/doc/source/docs/real_robot_setup.rst
diff --git a/doc/source/docs/software_architecture.rst b/doc/source/docs/software_architecture.rst
diff --git a/doc/source/fri.Doxyfile b/doc/source/fri.Doxyfile
@@ -864,7 +864,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "../../fri"
+INPUT                  = "fri"
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -3,14 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. mdinclude:: ../../lbr_fri_ros2_stack/README.md
+.. mdinclude:: lbr_fri_ros2_stack/README.md
 
 .. toctree::
    :hidden:
 
-   docs/doxygen/fri/html/index
-   docs/doxygen/lbr_fri_ros2/html/index
+   lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/lbr_fri_ros2_stack
+   lbr_fri_ros2_stack/lbr_demos/doc/lbr_demos
+   lbr_fri_ros2_stack/lbr_fri_ros2/doc/lbr_fri_ros2
+   fri/doc/fri
    docs/additional_resources
-   docs/demos
-   docs/real_robot_setup
-   docs/software_architecture
diff --git a/doc/source/lbr_fri_ros2.Doxyfile b/doc/source/lbr_fri_ros2.Doxyfile
@@ -864,7 +864,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "../../lbr_fri_ros2_stack/lbr_fri_ros2"
+INPUT                  = "lbr_fri_ros2_stack/lbr_fri_ros2"
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 doxysphinx
+sphinx-copybutton
 sphinx-mdinclude
 vcstool