Update requirements.txt dependencies for sphinx 4.3.1 (#51)

* Update requirements.txt dependencies for sphinx 4.3.1 Signed-off-by: Raul Sanchez-Mateos <[email protected]> * Use current branch for testing the action Signed-off-by: Raul Sanchez-Mateos <[email protected]> * Fix docs dependencies action call Signed-off-by: Raul Sanchez-Mateos <[email protected]> * Update action branches Signed-off-by: Raul Sanchez-Mateos <[email protected]> --------- Signed-off-by: Raul Sanchez-Mateos <[email protected]>
eProsima · Jan 16, 2024 · 103f38b · 103f38b
1 parent 27c98f2
commit 103f38b
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 5 deletions.
diff --git a/ubuntu/install_documentation_requirements/action.yml b/ubuntu/install_documentation_requirements/action.yml
@@ -1,20 +1,41 @@
 name: 'install_documentation_requirements'
 description: 'Install sphinx requirements following eProsima use case'
 
+inputs:
+  path_to_requirements:
+    description: 'Path to requirements.txt file'
+    required: false
+    default: ''
+
 runs:
   using: composite
   steps:
 
     - name: Install docs requirements with pip
       uses: eProsima/eProsima-CI/ubuntu/install_python_packages@main
+      if: ${{ inputs.path_to_requirements == '' }}
       with:
         packages: \
-          sphinx==4.3.1 \
-          sphinx==4.3.1 \
           doc8==0.10.1 \
           sphinx_rtd_theme==0.5.2 \
-          sphinxcontrib.spelling==7.2.1 \
+          sphinx-sitemap==2.2.0 \
+          sphinx-tabs==3.2.0 \
+          sphinx==4.3.1 \
+          sphinxcontrib-applehelp==1.0.4 \
+          sphinxcontrib-devhelp==1.0.2 \
+          sphinxcontrib-htmlhelp==2.0.1 \
           sphinxcontrib-imagehelper==1.1.1 \
-          sphinx-tabs==3.2.0
+          sphinxcontrib-plantuml==0.22 \
+          sphinxcontrib-qthelp==1.0.3 \
+          sphinxcontrib-serializinghtml==1.1.5 \
+          sphinxcontrib.spelling==7.2.1 \
+          vcstool==0.3.0 \
+          xmlschema==2.1.1
+
+    - name: Install docs requirements with pip
+      uses: eProsima/eProsima-CI/ubuntu/install_python_packages@main
+      if: ${{ inputs.path_to_requirements != '' }}
+      with:
+        requirements_file_name: ${{ inputs.path_to_requirements }}
 
 # TODO (jparisu) it would be nice if this action uses a common requirements.txt file, downloading it from somwhere (this repo, cpp-style... don't know)
diff --git a/ubuntu/sphinx_docs/action.yml b/ubuntu/sphinx_docs/action.yml
@@ -24,6 +24,11 @@ description: Build and test documentation using sphinx
 
 inputs:
 
+  checkout_path:
+    description: 'Path where the original repository will be downloaded (Default: <github-workspace>/src)'
+    required: false
+    default: 'src'
+
   docs_subpackage_name:
     description: Name of colcon subpackage that contains the sphinx documentation
     required: false
@@ -40,17 +45,24 @@ inputs:
     required: false
     default: ''
 
+  path_to_requirements:
+    description: 'Path to requirements.txt file'
+    required: false
+    default: ''
+
 runs:
   using: composite
   steps:
 
     - name: Sync repository
       uses: eProsima/eProsima-CI/external/checkout@main
       with:
-        path: src
+        path: ${{ inputs.checkout_path }}
 
     - name: Install docs dependencies
       uses: eProsima/eProsima-CI/ubuntu/install_documentation_requirements@main
+      with:
+        path_to_requirements: ${{ inputs.path_to_requirements }}
 
     - name: Install Colcon
       uses: eProsima/eProsima-CI/ubuntu/install_colcon@main