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

Documentation build issues #180

Closed
bgyori opened this issue Jun 19, 2023 · 1 comment · Fixed by #186
Closed

Documentation build issues #180

bgyori opened this issue Jun 19, 2023 · 1 comment · Fixed by #186

Comments

@bgyori
Copy link
Member

bgyori commented Jun 19, 2023

Currently the docs builds are failing due to two issues:

  • Dependencies:
WARNING: autodoc: failed to import module 'construct' from module 'mira.dkg'; the following exception was raised:
No module named 'pyobo'

This would require (a) hiding the pyobo import inside some funnction, or (b) putting pyobo in as a requirement for the docs build to have it be installed (c) mocking pyobo.

  • Jinja issues:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/sphinx/builders/html/__init__.py", line 1093, in handle_page
    output = self.templates.render(templatename, ctx)
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/readthedocs_ext/readthedocs.py", line 181, in rtd_render
    content = old_render(template, render_context)
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/sphinx/jinja2glue.py", line 196, in render
    return self.environment.get_template(template).render(context)
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/sphinx/themes/basic/page.html", line 10, in top-level template code
    {%- extends "layout.html" %}
  File "/home/docs/checkouts/readthedocs.org/user_builds/miramodel/envs/latest/lib/python3.8/site-packages/sphinx_rtd_theme/layout.html", line 23, in top-level template code
    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
jinja2.exceptions.UndefinedError: 'style' is undefined

This implies some sort of incompatibility between Sphinx's RTD theme package and Jinja.

@kkaris
Copy link
Contributor

kkaris commented Jun 28, 2023

Working on it in #186

@kkaris kkaris mentioned this issue Jun 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants