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

Some errors in the documentation files cause the build to fail in readthedocs #2087

Closed
fv3rdugo opened this issue Sep 17, 2024 · 2 comments
Closed
Assignees

Comments

@fv3rdugo
Copy link
Member

Copy & paste from Readthedocs logs.

[..]
reading sources... [100%] index

/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:2: WARNING: Title underline too short.

Install Ravada on Rocky Linux 9 or RHEL9
======================== [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:5: WARNING: Title underline too short.

Add Pre-Requisite Software
------------ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:41: WARNING: Title underline too short.

Add Another Pre-Requisite Software
------------ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:41: WARNING: Title underline too short.

Add Another Pre-Requisite Software
------------ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:116: WARNING: Title underline too short.

Make sure you are in root folder
------------- [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:116: WARNING: Title underline too short.

Make sure you are in root folder
------------- [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:124: WARNING: Title underline too short.

Download Ravada from Git Repo
-------------- [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:124: WARNING: Title underline too short.

Download Ravada from Git Repo
-------------- [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/INSTALL_Rocky9.rst:176: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/auth_openid.rst:18: WARNING: Title underline too short.

Configure module

/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/auth_openid.rst:18: WARNING: Title underline too short.

Configure module
~~~~~~~~~~~~~~~ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/auth_openid.rst:80: WARNING: image file not readable: docs/images/enable_openid.jpg [image.not_readable]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/report_rrdgraph.rst:6: WARNING: Include file '/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/report_rrd.sh' not found or reading it failed [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/update_safe.rst:8: WARNING: Title underline too short.

Step 1: Shutdown the services
--------------------- [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/update_safe.rst:20: WARNING: Title underline too short.

Step 2.1: Keep the package file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst:79: WARNING: Title underline too short.

Add members to many groups
------------------------ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst:79: WARNING: Title underline too short.

Add members to many groups
------------------------ [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst:19: WARNING: image file not readable: docs/image/upload_users_plain.png [image.not_readable]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst:39: WARNING: image file not readable: docs/image/upload_users_openid.png [image.not_readable]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst:53: WARNING: image file not readable: docs/image/manage_group_members.png [image.not_readable]
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/index.rst:55: WARNING: toctree contains reference to nonexisting document 'docs/sso_openid' [toc.not_readable]
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/devel-docs/create_grants.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/devel-docs/profiling.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/Debian_install.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/Localized_ISO_download.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/RDP_connection.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/ROADMAP.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/Ubuntu_Installation.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/apache_ssl.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/auth_openid.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/compact.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/frontend_security_policy.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/install_tpm.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/mount_virtual_volume.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/replace_server.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/report_rrdgraph.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/users_upload.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/ravada/checkouts/latest/docs/docs/volume_differences.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... 
copying static files... done
copying extra files... done
copying assets: done
writing output... [  1%] devel-docs/commit-rules
/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/readthedocs_ext/readthedocs.py:120: RemovedInSphinx90Warning: 'sphinx.builders.html.StandaloneHTMLBuilder.script_files' is deprecated. Check CHANGES for Sphinx API modifications.
  hasattr(app.builder, 'script_files'),
/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/readthedocs_ext/readthedocs.py:121: RemovedInSphinx90Warning: 'sphinx.builders.html.StandaloneHTMLBuilder.script_files' is deprecated. Check CHANGES for Sphinx API modifications.
  js_file not in app.builder.script_files,
/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/readthedocs_ext/readthedocs.py:121: RemovedInSphinx90Warning: The str interface for _JavaScript objects is deprecated. Use js.filename instead.
  js_file not in app.builder.script_files,

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 1160, in handle_page
    output = self.templates.render(templatename, ctx)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/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/ravada/envs/latest/lib/python3.11/site-packages/sphinx/jinja2glue.py", line 201, in render
    return self.environment.get_template(template).render(context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/jinja2/environment.py", line 1304, in render
    self.environment.handle_exception()
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/jinja2/environment.py", line 939, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/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/ravada/envs/latest/lib/python3.11/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

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 337, in build_main
    app.build(args.force_all, args.filenames)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 378, in build
    self.builder.build_update()
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 296, in build_update
    self.build(to_build,
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 366, in build
    self.write(docnames, list(updated_docnames), method)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 613, in write
    self._write_serial(sorted(docnames))
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 623, in _write_serial
    self.write_doc(docname, doctree)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 675, in write_doc
    self.handle_page(docname, ctx, event_arg=doctree)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 1167, in handle_page
    raise ThemeError(__("An error happened in rendering the page %s.\nReason: %r") %
sphinx.errors.ThemeError: An error happened in rendering the page devel-docs/commit-rules.
Reason: UndefinedError("'style' is undefined")

Theme error:
An error happened in rendering the page devel-docs/commit-rules.
Reason: UndefinedError("'style' is undefined")
@fv3rdugo fv3rdugo self-assigned this Sep 17, 2024
fv3rdugo added a commit that referenced this issue Sep 17, 2024
@fv3rdugo
Copy link
Member Author

unreferenced commit f1e73d5

@fv3rdugo
Copy link
Member Author

This error:

  File "/home/docs/checkouts/readthedocs.org/user_builds/ravada/envs/latest/lib/python3.11/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

it's explained here readthedocs/sphinx_rtd_theme#1465

fv3rdugo added a commit that referenced this issue Sep 17, 2024
Try to change to other version
fv3rdugo added a commit that referenced this issue Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant