Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: make html and html-fast failure #72087

Closed
bravl opened this issue Apr 29, 2024 · 1 comment · Fixed by #72098
Closed

doc: make html and html-fast failure #72087

bravl opened this issue Apr 29, 2024 · 1 comment · Fixed by #72098
Assignees
Labels
area: Documentation Infrastructure bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug

Comments

@bravl
Copy link
Contributor

bravl commented Apr 29, 2024

Describe the bug
make html and make html-fast fail with the following error:

# Platform:         linux; (Linux-6.6.13-200.fc39.x86_64-x86_64-with-glibc2.38)
# Sphinx version:   7.1.2
# Python version:   3.12.2 (CPython)
# Docutils version: 0.20.1
# Jinja2 version:   3.1.3
# Pygments version: 2.17.2

# Last messages:


# Loaded extensions:


# Traceback:
Traceback (most recent call last):
  File "/home/bravl/.local/lib/python3.12/site-packages/sphinx/cmd/build.py", line 285, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/bravl/.local/lib/python3.12/site-packages/sphinx/application.py", line 229, in __init__
    self.setup_extension(extension)
  File "/home/bravl/.local/lib/python3.12/site-packages/sphinx/application.py", line 402, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/bravl/.local/lib/python3.12/site-packages/sphinx/registry.py", line 441, in load_extension
    mod = import_module(extname)
          ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib64/python3.12/importlib/__init__.py", line 90, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 995, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/home/bravl/build/zephyr-upstream/zephyr/doc/_extensions/zephyr/gh_utils.py", line 56, in <module>
    MAINTAINERS : Final[Maintainers] = Maintainers(filename=f"{ZEPHYR_BASE}/MAINTAINERS.yml")
                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/bravl/build/zephyr-upstream/zephyr/scripts/get_maintainer.py", line 186, in __init__
    for area_name, area_dict in _load_maintainers(self.filename).items():
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/bravl/build/zephyr-upstream/zephyr/scripts/get_maintainer.py", line 470, in _load_maintainers
    _check_maintainers(path, yaml)
  File "/home/bravl/build/zephyr-upstream/zephyr/scripts/get_maintainer.py", line 529, in _check_maintainers
    ferr("glob pattern '{}' in '{}' in area '{}' does not "
  File "/home/bravl/build/zephyr-upstream/zephyr/scripts/get_maintainer.py", line 481, in ferr
    _err("{}: {}".format(maints_path, msg))  # Prepend the filename
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/bravl/build/zephyr-upstream/zephyr/scripts/get_maintainer.py", line 590, in _err
    raise MaintainersError(msg)
get_maintainer.MaintainersError: /home/bravl/build/zephyr-upstream/zephyr/MAINTAINERS.yml: glob pattern 'drivers/*/*xmc*/' in 'files' in area 'Infineon Platforms' does not match any files

To Reproduce
Steps to reproduce the behavior:

  1. cd docs
  2. make html-fast
  3. See error

Expected behavior
Documention should be built

Impact
Low

Logs and console output
See issue description for logs

Additional context
The issue can be fixed by applying the following patch:

From da483119951bcefc39203b5dedbe6d12dd9d790f Mon Sep 17 00:00:00 2001
From: Bram Vlerick <bram.vlerick@openpixelsystems.org>
Date: Mon, 29 Apr 2024 14:02:02 +0200
Subject: [PATCH] doc: fix make html and make html-fast

The make html and make html-fast builds fail while trying to match the
following patterns in the MAINTAINERS.yml file:
- drivers/*/*stm32*/
- drivers/*/*xmc*/

Signed-off-by: Bram Vlerick <bram.vlerick@openpixelsystems.org>
---
 MAINTAINERS.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/MAINTAINERS.yml b/MAINTAINERS.yml
index ad54288ce8..71ba7621c9 100644
--- a/MAINTAINERS.yml
+++ b/MAINTAINERS.yml
@@ -3569,7 +3569,7 @@ STM32 Platforms:
     - GeorgeCGV
   files:
     - boards/st/
-    - drivers/*/*stm32*/
+    - drivers/*/*stm32*
     - drivers/*/*stm32*.c
     - drivers/*/*stm32*.h
     - drivers/*/*/*stm32*
@@ -3698,7 +3698,7 @@ Infineon Platforms:
     - boards/cypress/
     - boards/infineon/
     - drivers/*/*ifx_cat1*
-    - drivers/*/*xmc*/
+    - drivers/*/*xmc*
     - drivers/*/*xmc*.c
     - drivers/sensor/infineon/
     - dts/arm/infineon/
-- 
2.44.0

@bravl bravl added the bug The issue is a bug, or the PR is fixing a bug label Apr 29, 2024
Copy link

Hi @bravl! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Infrastructure bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants