ci: documentation: Fix project directory structure handling

The documentation check script incorrectly assumed both drivers and projects
follow the same directory structure. Projects are organized directly under
projects/ but their documentation is categorized under subdirectories in
doc/sphinx/source/projects/, while drivers follow the expected structure
of drivers/category/driver_name/.

This fix handles projects separately by:
- Finding the .rst file anywhere under doc/sphinx/source/projects/
- Extracting the category from the actual file location
- Checking the appropriate wildcard pattern in projects_doc.rst

Fixes: 77d5a55 ("doc: reorganize sphinx docs with subdir categories")

Signed-off-by: Alexandra Miclaus <alexandra.miclaus@analog.com>

Author: amiclaus

ci/documentation.sh

@@ -67,24 +67,45 @@ check_sphinx_doc() {
                         local top_dir=$(echo "$file" | cut -d'/' -f1)
                         local second_dir=$(echo "$file" | cut -d'/' -f2)
 
-                        # Check if the corresponding .rst file exists in the expected subdirectory
-                        if [ -f "$sphinx_path/$top_dir/$second_dir/$fn_dir.rst" ]; then
-                                # File exists in the expected subdirectory, now check if category is in toctree
-                                wildcard_pattern="$top_dir/$second_dir/\*"
-                                if ! grep -q "$wildcard_pattern" "$sphinx_path/${top_dir}_doc.rst"; then
-                                        echo_red "Missing wildcard pattern '$wildcard_pattern' in $sphinx_path/${top_dir}_doc.rst"
+                        # Handle different directory structures for drivers vs projects
+                        if [ "$top_dir" = "projects" ]; then
+                                # Projects are directly under projects/ but docs are categorized
+                                # Find the .rst file anywhere under doc/sphinx/source/projects/
+                                if find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | grep -q .; then
+                                        # File exists, find its category and check if wildcard is in toctree
+                                        actual_location=$(find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | head -1)
+                                        category_dir=$(basename "$(dirname "$actual_location")")
+                                        wildcard_pattern="$top_dir/$category_dir/\*"
+                                        if ! grep -q "$wildcard_pattern" "$sphinx_path/${top_dir}_doc.rst"; then
+                                                echo_red "Missing wildcard pattern '$wildcard_pattern' in $sphinx_path/${top_dir}_doc.rst"
+                                                exit 1
+                                        fi
+                                else
+                                        # File doesn't exist at all
+                                        echo_red "Missing $fn_dir.rst file under $sphinx_path/$top_dir"
                                         exit 1
                                 fi
-                        elif find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | grep -q .; then
-                                # File exists but in wrong subdirectory
-                                actual_location=$(find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | head -1)
-                                expected_location="$sphinx_path/$top_dir/$second_dir/$fn_dir.rst"
-                                echo_red "File $fn_dir.rst found at $actual_location but expected at $expected_location"
-                                exit 1
                         else
-                                # File doesn't exist at all
-                                echo_red "Missing $fn_dir.rst file under $sphinx_path/$top_dir"
-                                exit 1
+                                # For drivers and other top-level directories, use the original logic
+                                # Check if the corresponding .rst file exists in the expected subdirectory
+                                if [ -f "$sphinx_path/$top_dir/$second_dir/$fn_dir.rst" ]; then
+                                        # File exists in the expected subdirectory, now check if category is in toctree
+                                        wildcard_pattern="$top_dir/$second_dir/\*"
+                                        if ! grep -q "$wildcard_pattern" "$sphinx_path/${top_dir}_doc.rst"; then
+                                                echo_red "Missing wildcard pattern '$wildcard_pattern' in $sphinx_path/${top_dir}_doc.rst"
+                                                exit 1
+                                        fi
+                                elif find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | grep -q .; then
+                                        # File exists but in wrong subdirectory
+                                        actual_location=$(find "$sphinx_path/$top_dir" -name "$fn_dir.rst" -type f | head -1)
+                                        expected_location="$sphinx_path/$top_dir/$second_dir/$fn_dir.rst"
+                                        echo_red "File $fn_dir.rst found at $actual_location but expected at $expected_location"
+                                        exit 1
+                                else
+                                        # File doesn't exist at all
+                                        echo_red "Missing $fn_dir.rst file under $sphinx_path/$top_dir"
+                                        exit 1
+                                fi
                         fi
                 fi
         done