Sphinx 4.1.0 breaks our docs build

[paulgessinger]

Not sure what to do about it yet, I'm locking the versions again for now.

See this job:

WARNING: the exhale extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit
WARNING: doing serial read
/__w/acts/acts/docs/api/class_acts_1_1_assertion_failure_exception_1_1_stream_formatter.rst:19: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_assertion_failure_exception:32.
Declaration is '.. cpp:class:: Acts::AssertionFailureException::StreamFormatter'.
/__w/acts/acts/docs/api/class_acts_1_1_assertion_failure_exception_1_1_stream_formatter.rst:19: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_assertion_failure_exception:32.
Declaration is '.. cpp:function:: template<typename T> inline StreamFormatter & operator<< (const T &value)'.
/__w/acts/acts/docs/api/class_acts_1_1_cone_surface.rst:28: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_cone_surface:28.
Declaration is '.. cpp:function:: Vector3 normal (const GeometryContext &gctx, const Vector2 &lposition) const=0'.
/__w/acts/acts/docs/api/class_acts_1_1_cone_surface.rst:28: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_cone_surface:28.
Declaration is '.. cpp:function:: virtual Vector3 normal (const GeometryContext &gctx, const Vector3 &position) const final'.
/__w/acts/acts/docs/api/class_acts_1_1_cylinder_surface.rst:28: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_cylinder_surface:28.
Declaration is '.. cpp:function:: Vector3 normal (const GeometryContext &gctx, const Vector2 &lposition) const=0'.
/__w/acts/acts/docs/api/class_acts_1_1_cylinder_surface.rst:28: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_cylinder_surface:28.
Declaration is '.. cpp:function:: virtual Vector3 normal (const GeometryContext &gctx, const Vector3 &position) const final'.
/__w/acts/acts/docs/api/class_acts_1_1_disc_surface.rst:28: WARNING: Duplicate C++ declaration, also defined at api/class_acts_1_1_disc_surface:28.
Declaration is '.. cpp:function:: Vector3 normal (const GeometryContext &gctx, const Vector2 &lposition) const=0'.

Exception occurred:
  File "/usr/local/lib/python3.8/dist-packages/sphinx/util/cfamily.py", line 275, in fail
    raise self._make_multi_error(errors, '')
sphinx.util.cfamily.DefinitionError: Invalid C++ declaration: Expected identifier in nested name. [error at 8]
  typename...
  --------^
The full traceback has been saved in /tmp/sphinx-err-vjl28faf.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
ninja: build stopped: subcommand failed.
Error: Process completed with exit code 1.

[paulgessinger]

I'm attaching the logs here, because they will eventually expire on the CI job itself.

docs.zip

[stale]

This issue/PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[whit2333]

@paulgessinger ,

Is there still a doxygen build for the docs? I have always found sphinx/RTDs style good for manuals but not able to match doxygen for code documentation.

For example, the current documentation doesn't have documentation for the main dd4hep plugin function
convertDD4hepDetector.

[paulgessinger]

We run doxygen but only pull in the information into sphinx. Theoretically, everything that doxygen saw should be in there. I faintly remember there was a problem with doxygen processing the plugins, so I believe none of the plugins are visible there. I'll have look if I can fix this.

[paulgessinger]

It seems this issue will be fixed in breathe-doc/breathe#711, allowing us to bump sphinx.