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

PDF/LaTeX build of the documentation fails #22

Open
elliotfontaine opened this issue Jun 21, 2024 · 0 comments · Fixed by #23
Open

PDF/LaTeX build of the documentation fails #22

elliotfontaine opened this issue Jun 21, 2024 · 0 comments · Fixed by #23
Assignees
Labels
type:bug Something isn't working type:documentation Improvements or additions to documentation

Comments

@elliotfontaine
Copy link
Contributor

The LaTeX build of the documentation fails.

File "/home/docs/checkouts/readthedocs.org/user_builds/rtmet/envs/latest/lib/python3.12/site-packages/sphinx/writers/latex.py", line 785, in visit_desc_content
    assert self.in_desc_signature
           ^^^^^^^^^^^^^^^^^^^^^^
AssertionError

Exception occurred:
  File "/home/docs/checkouts/readthedocs.org/user_builds/rtmet/envs/latest/lib/python3.12/site-packages/sphinx/writers/latex.py", line 785, in visit_desc_content
    assert self.in_desc_signature
           ^^^^^^^^^^^^^^^^^^^^^^
AssertionError
The full traceback has been saved in /tmp/sphinx-err-dj3akq3d.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!

This may be related to

As it occured after the rose config file autodoc was introduced by #20, it may be hard to debug if it's because of the exotic sphinx extensions.
A fix could be found by simply changing sphinx / rtd versions.

This will require further investigation. For now, let's simply disable the PDF output.

@elliotfontaine elliotfontaine added type:bug Something isn't working type:documentation Improvements or additions to documentation labels Jun 21, 2024
@elliotfontaine elliotfontaine self-assigned this Jun 21, 2024
@elliotfontaine elliotfontaine linked a pull request Jun 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug Something isn't working type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant