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.

Sign up for GitHub

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

Jump to bottom

Wrong Empty modules section error (regression) #204

Closed
llucax opened this issue Aug 25, 2023 · 5 comments
Closed

Wrong Empty modules section error (regression) #204

llucax opened this issue Aug 25, 2023 · 5 comments

Comments

@llucax
Copy link

llucax commented Aug 25, 2023

Describe the bug

"""
Some comment

Some long description that spans more than one line and ends with "modules:" on the next line, like
modules:

* Breaks!
* With error: `Empty modules section at line 4`
"""

This is a regression, it didn't happen with griffe 0.31.0. I'm not using griffe directly, but from mkdocstrings and the dependency was indirectly updated.

Debug logs
No griffe logs.

$ mkdocs serve
DEBUG   -  Loading configuration file: /home/luca/devel/repo-config/mkdocs.yml
DEBUG   -  Loaded theme configuration for 'material' from '/home/luca/devel/repo-config/.direnv/python-3.11.4/lib/python3.11/site-packages/material/mkdocs_theme.yml': {'language': 'en', 'direction': None, 'features': [], 'font': {'text': 'Roboto', 'code': 'Roboto Mono'}, 'icon': None, 'favicon':
           'assets/images/favicon.png', 'static_templates': ['404.html']}
INFO    -  DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html
             File "/home/luca/devel/repo-config/.direnv/python-3.11.4/lib/python3.11/site-packages/mike/mkdocs_plugin.py", line 6, in <module>
               from pkg_resources import iter_entry_points
             File "/home/luca/devel/repo-config/.direnv/python-3.11.4/lib/python3.11/site-packages/pkg_resources/__init__.py", line 118, in <module>
               warnings.warn(
DEBUG   -  Config value 'config_file_path' = '/home/luca/devel/repo-config/mkdocs.yml'
DEBUG   -  Config value 'site_name' = 'Frequenz Repository Configuration'
DEBUG   -  Config value 'nav' = None
DEBUG   -  Config value 'pages' = None
DEBUG   -  Config value 'exclude_docs' = None
DEBUG   -  Config value 'not_in_nav' = None
DEBUG   -  Config value 'site_url' = None
DEBUG   -  Config value 'site_description' = 'Frequenz repository setup tools and common configuration'
DEBUG   -  Config value 'site_author' = 'Frequenz Energy-as-a-Service GmbH'
DEBUG   -  Config value 'theme' = Theme(name='material', dirs=['/home/luca/devel/repo-config/docs/overrides', '/home/luca/devel/repo-config/.direnv/python-3.11.4/lib/python3.11/site-packages/material', '/home/luca/devel/repo-config/.direnv/python-3.11.4/lib/python3.11/site-packages/mkdocs/templates'],
           static_templates={'404.html', 'sitemap.xml'}, name='material', locale=Locale(language='en', territory=''), language='en', direction=None, features=['content.code.annotate', 'content.code.copy', 'navigation.instant', 'navigation.tabs', 'navigation.top', 'navigation.tracking', 'toc.follow'], font={'text':
           'Roboto', 'code': 'Roboto Mono'}, icon={'edit': 'material/file-edit-outline', 'repo': 'fontawesome/brands/github'}, favicon='logo.png', logo='logo.png', palette=[{'media': '(prefers-color-scheme: light)', 'scheme': 'default', 'primary': 'indigo', 'accent': 'deep purple', 'toggle': {'icon':
           'material/weather-sunny', 'name': 'Switch to dark mode'}}, {'media': '(prefers-color-scheme: dark)', 'scheme': 'slate', 'primary': 'black', 'accent': 'teal', 'toggle': {'icon': 'material/weather-night', 'name': 'Switch to light mode'}}])
DEBUG   -  Config value 'docs_dir' = '/home/luca/devel/repo-config/docs'
DEBUG   -  Config value 'site_dir' = '/home/luca/devel/repo-config/site'
DEBUG   -  Config value 'copyright' = 'Copyright © 2023 Frequenz Energy-as-a-Service GmbH'
DEBUG   -  Config value 'google_analytics' = None
DEBUG   -  Config value 'dev_addr' = _IpAddressValue(host='127.0.0.1', port=8000)
DEBUG   -  Config value 'use_directory_urls' = True
DEBUG   -  Config value 'repo_url' = 'https://github.com/frequenz-floss/frequenz-repo-config-python'
DEBUG   -  Config value 'repo_name' = 'frequenz-repo-config-python'
DEBUG   -  Config value 'edit_uri_template' = None
DEBUG   -  Config value 'edit_uri' = 'edit/v0.x.x/docs/'
DEBUG   -  Config value 'extra_css' = ['css/style.css', 'css/mkdocstrings.css']
DEBUG   -  Config value 'extra_javascript' = []
DEBUG   -  Config value 'extra_templates' = []
DEBUG   -  Config value 'markdown_extensions' = ['toc', 'tables', 'fenced_code', 'admonition', 'attr_list', 'pymdownx.details', 'pymdownx.highlight', 'pymdownx.keys', 'pymdownx.snippets', 'pymdownx.superfences', 'pymdownx.tabbed', 'pymdownx.tasklist']
DEBUG   -  Config value 'mdx_configs' = {'pymdownx.highlight': {'anchor_linenums': True, 'line_spans': '__span', 'pygments_lang_class': True}, 'pymdownx.snippets': {'check_paths': True}, 'pymdownx.superfences': {'custom_fences': [{'name': 'mermaid', 'class': 'mermaid', 'format':
           '!!python/name:pymdownx.superfences.fence_code_format'}]}, 'toc': {'permalink': '¤'}}
DEBUG   -  Config value 'strict' = True
DEBUG   -  Config value 'remote_branch' = 'gh-pages'
DEBUG   -  Config value 'remote_name' = 'origin'
DEBUG   -  Config value 'extra' = {'social': [{'icon': 'fontawesome/brands/github', 'link': 'https://github.com/frequenz-floss'}, {'icon': 'fontawesome/brands/linkedin', 'link': 'https://www.linkedin.com/company/frequenz-com'}], 'version': {'provider': 'mike', 'default': 'latest'}}
DEBUG   -  Config value 'plugins' = {'gen-files': <mkdocs_gen_files.plugin.GenFilesPlugin object at 0x7f9b7163af50>, 'literate-nav': <mkdocs_literate_nav.plugin.LiterateNavPlugin object at 0x7f9b72100390>, 'mike': <mike.mkdocs_plugin.MikePlugin object at 0x7f9b71661bd0>, 'mkdocstrings':
           <mkdocstrings.plugin.MkdocstringsPlugin object at 0x7f9b71662710>, 'material/search': <material.plugins.search.plugin.SearchPlugin object at 0x7f9b7130de50>, 'section-index': <mkdocs_section_index.plugin.SectionIndexPlugin object at 0x7f9b713e4750>}
DEBUG   -  Config value 'hooks' = {}
DEBUG   -  Config value 'watch' = ['/home/luca/devel/repo-config/cookiecutter/variable-reference.md', '/home/luca/devel/repo-config/src', '/home/luca/devel/repo-config/README.md', '/home/luca/devel/repo-config/CONTRIBUTING.md']
DEBUG   -  Config value 'validation' = {'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20, 'unrecognized_links': 20}}
DEBUG   -  Running 1 `startup` events
DEBUG   -  Running 3 `config` events
DEBUG   -  mkdocstrings: Adding extension to the list
DEBUG   -  mkdocstrings: Added a subdued autorefs instance <mkdocs_autorefs.plugin.AutorefsPlugin object at 0x7f9b713e6850>
DEBUG   -  mkdocstrings: Downloading inventory from 'https://cookiecutter.readthedocs.io/en/stable/objects.inv'
DEBUG   -  mkdocstrings: Downloading inventory from 'https://docs.python.org/3/objects.inv'
DEBUG   -  mkdocstrings: Downloading inventory from 'https://mkdocstrings.github.io/objects.inv'
DEBUG   -  mkdocstrings: Downloading inventory from 'https://nox.thea.codes/en/stable/objects.inv'
DEBUG   -  mkdocs_autorefs: Adding AutorefsExtension to the list
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/luca/devel/repo-config/site
DEBUG   -  Running 3 `files` events
DEBUG   -  Navigation for '.' based on 'SUMMARY.md'.
DEBUG   -  Navigation for 'reference' based on 'reference/SUMMARY.md'.
DEBUG   -  Running 2 `nav` events
DEBUG   -  Reading markdown pages.
DEBUG   -  Reading: index.md
DEBUG   -  Running 1 `page_markdown` events
INFO    -  Doc file 'index.md' contains an unrecognized relative link 'reference/frequenz/repo/config/', it was left as is. Did you mean 'reference/frequenz/repo/config/index.md'?
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: CONTRIBUTING.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: SUMMARY.md
DEBUG   -  Running 1 `page_markdown` events
INFO    -  Doc file 'SUMMARY.md' contains an unrecognized relative link 'reference/', it was left as is.
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/SUMMARY.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/index.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  griffe: Found frequenz: loading
DEBUG   -  griffe: Loading path [PosixPath('/home/luca/devel/repo-config/src/frequenz')]
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/__init__.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/protobuf.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/_core.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/mkdocs.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/nox/__init__.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/setuptools/__init__.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/pytest/__init__.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/nox/config.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/nox/session.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/nox/default.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/nox/util.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/setuptools/grpc_tools.py
DEBUG   -  griffe: Loading path /home/luca/devel/repo-config/src/frequenz/repo/config/pytest/examples.py
DEBUG   -  griffe: Alias frequenz.repo.config.RepositoryType was resolved to frequenz.repo.config._core.RepositoryType
DEBUG   -  griffe: Alias frequenz.repo.config.nox.configure was resolved to frequenz.repo.config.nox.config.configure
DEBUG   -  griffe: Iteration 1 finished, 2 aliases resolved, still 0 to go
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: Loaded inventory from 'https://nox.thea.codes/en/stable/objects.inv': 27 items
DEBUG   -  mkdocstrings: Downloading inventory from 'https://oprypin.github.io/mkdocs-gen-files/objects.inv'
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config
DEBUG   -  mkdocstrings: Loaded inventory from 'https://cookiecutter.readthedocs.io/en/stable/objects.inv': 106 items
DEBUG   -  mkdocstrings: Downloading inventory from 'https://setuptools.pypa.io/en/latest/objects.inv'
DEBUG   -  mkdocstrings: Loaded inventory from 'https://mkdocstrings.github.io/objects.inv': 71 items
DEBUG   -  mkdocstrings: Downloading inventory from 'https://sybil.readthedocs.io/en/stable/objects.inv'
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config
DEBUG   -  mkdocstrings: python/templates/material/class.html: Rendering frequenz.repo.config.RepositoryType
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.RepositoryType
DEBUG   -  griffe: Base class enum.Enum is not loaded, or not static, it cannot be resolved
DEBUG   -  mkdocstrings: Loaded inventory from 'https://docs.python.org/3/objects.inv': 9627 items
DEBUG   -  mkdocstrings: Downloading inventory from 'https://typing-extensions.readthedocs.io/en/stable/objects.inv'
DEBUG   -  mkdocstrings: Loaded inventory from 'https://oprypin.github.io/mkdocs-gen-files/objects.inv': 13 items
DEBUG   -  mkdocstrings: Loaded inventory from 'https://setuptools.pypa.io/en/latest/objects.inv': 164 items
DEBUG   -  mkdocstrings: Loaded inventory from 'https://sybil.readthedocs.io/en/stable/objects.inv': 98 items
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.RepositoryType.ACTOR
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.RepositoryType.API
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.RepositoryType.APP
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.RepositoryType.LIB
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.RepositoryType.MODEL
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/mkdocs.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.mkdocs'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.mkdocs
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.mkdocs
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.mkdocs.generate_protobuf_api_pages
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.mkdocs.generate_python_api_pages
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/protobuf.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.protobuf'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.protobuf
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.protobuf
DEBUG   -  mkdocstrings: python/templates/material/class.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.protobuf.ProtobufConfig
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.docs_path
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.include_paths
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.proto_glob
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.proto_path
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.py_path
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.protobuf.ProtobufConfig.from_pyproject_toml
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/nox/index.md
DEBUG   -  mkdocstrings: Loaded inventory from 'https://typing-extensions.readthedocs.io/en/stable/objects.inv': 101 items
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.nox'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.nox
WARNING -  griffe: src/frequenz/repo/config/nox/__init__.py:38: Empty modules section at line 34
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.configure
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/nox/config.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.nox.config'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.nox.config
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.config
DEBUG   -  mkdocstrings: python/templates/material/class.html: Rendering frequenz.repo.config.nox.config.CommandsOptions
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.config.CommandsOptions
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.black
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.darglint
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.isort
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.mypy
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.pydocstyle
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.pylint
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.pytest
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.CommandsOptions.copy
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/class.html: Rendering frequenz.repo.config.nox.config.Config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.config.Config
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.Config.extra_paths
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.Config.opts
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.Config.sessions
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.config.Config.source_paths
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.Config.__post_init__
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.Config.copy
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.Config.package_args
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.Config.path_args
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.configure
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.config.get
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/nox/default.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.nox.default'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.nox.default
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.default
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.actor_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.actor_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.api_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.api_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.app_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.app_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.common_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.common_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.lib_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.lib_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.model_command_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.nox.default.model_config
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/nox/session.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.nox.session'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.nox.session
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.session
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.ci_checks_max
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.docstrings
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.formatting
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.mypy
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.pylint
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.pytest_max
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.session.pytest_min
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/nox/util.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.nox.util'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.nox.util
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.nox.util
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.deduplicate
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.discover_paths
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.existing_paths
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/docstring/admonition.html: Rendering admonition
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.find_toplevel_package_dirs
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/docstring/examples.html: Rendering examples section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.flatten
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/docstring/admonition.html: Rendering admonition
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.is_python_file
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.min_dependencies
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/docstring/raises.html: Rendering raises section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.path_to_package
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  mkdocstrings: python/templates/material/docstring/examples.html: Rendering examples section
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.nox.util.replace
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/parameters.html: Rendering parameters section
DEBUG   -  mkdocstrings: python/templates/material/docstring/yields.html: Rendering yields section
DEBUG   -  mkdocstrings: python/templates/material/docstring/admonition.html: Rendering admonition
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/pytest/index.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.pytest'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.pytest
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.pytest
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/pytest/examples.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.pytest.examples'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.pytest.examples
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.pytest.examples
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.pytest.examples.get_sybil_arguments
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/docstring/returns.html: Rendering returns section
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/setuptools/index.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.setuptools'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.setuptools
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.setuptools
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Reading: reference/frequenz/repo/config/setuptools/grpc_tools.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: frequenz.repo.config.setuptools.grpc_tools'
DEBUG   -  mkdocstrings: Using handler 'python'
DEBUG   -  mkdocstrings: Collecting data
DEBUG   -  mkdocstrings: Updating renderer's env
DEBUG   -  mkdocstrings: Rendering templates
DEBUG   -  mkdocstrings: python/templates/material/module.html: Rendering frequenz.repo.config.setuptools.grpc_tools
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.setuptools.grpc_tools
DEBUG   -  mkdocstrings: python/templates/material/class.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/children.html: Rendering children of frequenz.repo.config.setuptools.grpc_tools.CompileProto
DEBUG   -  griffe: Base class setuptools.Command is not loaded, or not static, it cannot be resolved
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.description
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.include_paths
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.proto_glob
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.proto_path
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.py_path
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/attribute.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.user_options
DEBUG   -  mkdocstrings: python/templates/material/labels.html: Rendering labels
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.finalize_options
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.initialize_options
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  mkdocstrings: python/templates/material/function.html: Rendering frequenz.repo.config.setuptools.grpc_tools.CompileProto.run
DEBUG   -  mkdocstrings: python/templates/material/signature.html: Rendering signature
DEBUG   -  mkdocstrings: python/templates/material/docstring.html: Rendering docstring
DEBUG   -  Running 2 `page_content` events
DEBUG   -  Running 2 `env` events
DEBUG   -  mkdocstrings: Creating inventory file objects.inv
DEBUG   -  mkdocstrings: Waiting for 8 inventory download(s)
DEBUG   -  Copying static assets.
DEBUG   -  Copying media file: 'logo.png'
DEBUG   -  Copying media file: 'mkdocstrings_autoapi.py'
DEBUG   -  Copying media file: 'assets/images/favicon.png'
DEBUG   -  Copying media file: 'assets/javascripts/bundle.220ee61c.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/bundle.220ee61c.min.js.map'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/tinyseg.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/wordcut.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ar.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.da.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.de.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.du.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.es.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.fi.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.fr.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.hi.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.hu.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.hy.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.it.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ja.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.jp.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.kn.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ko.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.multi.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.nl.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.no.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.pt.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ro.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ru.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.sa.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.stemmer.support.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.sv.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.ta.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.te.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.th.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.tr.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.vi.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/lunr/min/lunr.zh.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/workers/search.74e28a9f.min.js'
DEBUG   -  Copying media file: 'assets/javascripts/workers/search.74e28a9f.min.js.map'
DEBUG   -  Copying media file: 'assets/stylesheets/main.eebd395e.min.css'
DEBUG   -  Copying media file: 'assets/stylesheets/main.eebd395e.min.css.map'
DEBUG   -  Copying media file: 'assets/stylesheets/palette.ecc896b0.min.css'
DEBUG   -  Copying media file: 'assets/stylesheets/palette.ecc896b0.min.css.map'
DEBUG   -  Copying media file: 'css/mkdocstrings.css'
DEBUG   -  Copying media file: 'css/style.css'
DEBUG   -  Copying media file: 'overrides/main.html'
DEBUG   -  Building theme template: 404.html
DEBUG   -  Building theme template: sitemap.xml
DEBUG   -  Gzipping template: sitemap.xml
DEBUG   -  Building markdown pages.
DEBUG   -  Building page index.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page index.md
DEBUG   -  Building page CONTRIBUTING.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page CONTRIBUTING.md
DEBUG   -  Building page SUMMARY.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page SUMMARY.md
DEBUG   -  Building page reference/SUMMARY.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/SUMMARY.md
DEBUG   -  Building page reference/frequenz/repo/config/index.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/index.md
DEBUG   -  Building page reference/frequenz/repo/config/mkdocs.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/mkdocs.md
DEBUG   -  Building page reference/frequenz/repo/config/protobuf.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/protobuf.md
DEBUG   -  Building page reference/frequenz/repo/config/nox/index.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/nox/index.md
DEBUG   -  Building page reference/frequenz/repo/config/nox/config.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/nox/config.md
DEBUG   -  Building page reference/frequenz/repo/config/nox/default.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/nox/default.md
DEBUG   -  Building page reference/frequenz/repo/config/nox/session.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/nox/session.md
DEBUG   -  Building page reference/frequenz/repo/config/nox/util.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/nox/util.md
DEBUG   -  Building page reference/frequenz/repo/config/pytest/index.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/pytest/index.md
DEBUG   -  Building page reference/frequenz/repo/config/pytest/examples.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/pytest/examples.md
DEBUG   -  Building page reference/frequenz/repo/config/setuptools/index.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/setuptools/index.md
DEBUG   -  Building page reference/frequenz/repo/config/setuptools/grpc_tools.md
DEBUG   -  Running 2 `page_context` events
DEBUG   -  Running 1 `post_page` events
DEBUG   -  mkdocs_autorefs: Fixing references in page reference/frequenz/repo/config/setuptools/grpc_tools.md
DEBUG   -  Running 4 `post_build` events
DEBUG   -  mkdocstrings: Tearing handlers down

Aborted with 1 warnings in strict mode!

To Reproduce
Steps to reproduce the behavior:

I hope it is enough to show a public repo with this issue.

You can see a GitHub workflow failing here: https://github.com/frequenz-floss/frequenz-repo-config-python/actions/runs/5980689722/job/16227308937?pr=125

Expected behavior
It should work as before. A paragraph split in more than one line shouldn't be considered a section.

System (please complete the following information):

  • griffe version: 0.35.0
  • Python version: 3.11.4
  • OS: Linux (debian testing)

Additional context
None.
llucax added a commit to llucax/frequenz-repo-config-python that referenced this issue Aug 25, 2023
@llucax
Workaround mkdocstrings bug
4465ec7 
With griffe 0.35.0 (used by mkdocstrings), this line started to fail
with an error `Empty modules section at line ...`.

For now we are just working around it until the bug is fixed. See:
mkdocstrings/griffe#204

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax llucax mentioned this issue Aug 25, 2023
Merged
@pawamoy
Copy link
Member

pawamoy commented Aug 26, 2023

Thanks for the report!

Yes, latest Griffe added support for Modules, Classes, Functions and Methods sections. The parser is a bit too lax, I'll add an option to make it more strict, and we'll add a deprecation period for the default behavior, to switch to strict by default at some point.

pawamoy added a commit that referenced this issue Aug 27, 2023
@pawamoy
refactor: Be more strict when parsing sections in Google docstrings
6a8a228 
Issue #204: #204
@pawamoy
Copy link
Member

pawamoy commented Aug 27, 2023

In the end I didn't add an option. I expect most users already use valid syntax for sections. The docs mention a way to find out possibly invalid syntax. Released in v0.35.2.

@pawamoy pawamoy closed this as completed Aug 27, 2023
@llucax
Copy link
Author

llucax commented Aug 27, 2023

Hi @pawamoy , thanks for addressing this so quickly. So it's unclear for me if this is expected behaviour from now on or not. It is now invalid to have just the words modules: in its own line?

Asking to know how should we format our doc comments. Thanks!

@pawamoy
Copy link
Member

pawamoy commented Aug 27, 2023

Oh, good question, I guess I could have given more explanations.

Your example docstring above is perfectly valid. Before, the parser would parse it as an empty modules section, which was wrong. Now, with our stricter parsing rules, it is correctly parsed as regular text.

I hope this answers your question.

llucax added a commit to llucax/frequenz-repo-config-python that referenced this issue Aug 28, 2023
@llucax
Workaround mkdocstrings bug
3bb1ed2 
With griffe 0.35.0 (used by mkdocstrings), this line started to fail
with an error `Empty modules section at line ...`.

For now we are just working around it until the bug is fixed. See:
mkdocstrings/griffe#204

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax added a commit to llucax/frequenz-repo-config-python that referenced this issue Aug 28, 2023
@llucax
Workaround mkdocstrings bug
973c299 
With griffe 0.35.0 (used by mkdocstrings), this line started to fail
with an error `Empty modules section at line ...`.

For now we are just working around it until the bug is fixed. See:
mkdocstrings/griffe#204

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax
Copy link
Author

llucax commented Aug 29, 2023

Yes, crystal clear now! Thanks!

@hugovk hugovk mentioned this issue Oct 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@llucax @pawamoy