boostorg / docca

Boost.Book XSLT C++ documentation system
Boost Software License 1.0
17 stars 22 forks source link

boostorg/mysql docs not building #184

Open sdarwin opened 2 days ago

sdarwin commented 2 days ago

boostorg/mysql docs are not building on macOS and Windows. Getting the following error.

  File "/Users/runner/work/release-tools/release-tools/github/boostorg/boost/tools/docca/include/docca/quickbook/components.jinja2", line 498, in template
    {%- for part in member.brief -%}
^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/runner/venvboostdocs/lib/python3.12/site-packages/jinja2/runtime.py", line 417, in __init__
    self._iterator = self._to_iterator(iterable)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/runner/venvboostdocs/lib/python3.12/site-packages/jinja2/runtime.py", line 425, in _to_iterator
    return iter(iterable)
           ^^^^^^^^^^^^^^
jinja2.exceptions.UndefinedError: '__main__.OverloadSet object' has no attribute 'brief'

See https://github.com/sdarwin/release-tools/actions/runs/11525770777/job/32088676007

In the "docs" job, search for: DOCS BUILD FAILED. LIBRARY mysql , and scroll up.

It's possible that a python dependency is missing, or a configuration issue, in which case there is nothing wrong with docca. Any ideas?

cc: @anarthal

anarthal commented 2 days ago

This looks like it's hitting a known docca issue. If that's the case, it should be failing for Linux, too. Can you confirm whether this is the case?

Will look into it in a couple hours anyway.

sdarwin commented 2 days ago

, it should be failing for Linux, too

It's succeeding on Linux. Also, the main boost releases (on linux) are ok.

grisumbras commented 2 days ago

I'll look into this tomorrow. ~Is it failing on develop or master?~

anarthal commented 2 days ago

It's hitting this docca issue: https://github.com/boostorg/docca/issues/170

We don't see it in Linux because it doesn't happen with Doxygen 1.9, but it does with Doxygen 1.12.

anarthal commented 2 days ago

IIRC the problem can be workarounded by removing the \relates commands from the documentation. This is not ideal, but can be an option if fixing this in docca is too complex to be achieved on time for the release. @grisumbras do you think this could be fixed on your side?

grisumbras commented 2 days ago

Yeah, I think I can do this in time.

anarthal commented 2 days ago

Great, thanks.