layout.html 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. {% extends "!layout.html" -%}
  2. {# Refer to https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html #}
  3. {% block htmltitle -%}
  4. <title>{{ godot_title_prefix }}{{ title|striptags|e }}{{ titlesuffix }}</title>
  5. {% endblock -%}
  6. {% block extrahead -%}
  7. <meta name="doc_version" content="{{ version }}" />
  8. <meta name="doc_is_latest" content="{{ godot_is_latest }}" />
  9. <meta name="doc_pagename" content="{{ pagename }}" />
  10. {% endblock -%}
  11. {% block linktags -%}
  12. <meta name="theme-color" content="#3d8fcc" />
  13. {{ super() }}
  14. {% endblock -%}
  15. {%- block document %}
  16. <div itemprop="articleBody">
  17. {% if godot_is_latest or godot_show_article_status %}
  18. <div class="admonition-grid">
  19. {% if godot_is_latest %}
  20. <div class="admonition attention latest-notice">
  21. <p class="first admonition-title">Attention: Here be dragons</p>
  22. <p>
  23. This is the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
  24. (unstable) version of this documentation, which may document features
  25. not available in or compatible with released stable versions of Godot.
  26. </p>
  27. <p class="last latest-notice-link">
  28. Checking the stable version of the documentation...
  29. </p>
  30. </div>
  31. {% endif %}
  32. {% if godot_show_article_status and not godot_is_latest and meta and meta.get('article_outdated') == 'True' %}
  33. <div class="admonition attention article-status">
  34. <p class="first admonition-title">Work in progress</p>
  35. <p>
  36. The content of this page was not yet updated for Godot
  37. <code class="docutils literal notranslate">{{ godot_version }}</code>
  38. and may be <strong>outdated</strong>. If you know how to improve this page or you can confirm
  39. that it's up to date, feel free to <a href="https://github.com/godotengine/godot-docs">open a pull request</a>.
  40. </p>
  41. </div>
  42. {% endif %}
  43. </div>
  44. {% endif %}
  45. {% block body %}{% endblock %}
  46. {% if (not meta or meta.get('allow_comments') != 'False') and godot_show_article_comments %}
  47. <div id="godot-giscus">
  48. {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
  49. <div class="rst-footer-buttons" role="navigation">
  50. {%- if prev %}
  51. <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
  52. {%- endif %}
  53. {%- if next %}
  54. <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  55. {%- endif %}
  56. </div>
  57. {%- endif %}
  58. <hr>
  59. <h2>User-contributed notes</h2>
  60. <p>
  61. <em>Please read the <a href="https://github.com/godotengine/godot-docs-user-notes/discussions/1">User-contributed notes policy</a> before submitting a comment.</em>
  62. </p>
  63. </div>
  64. {% endif %}
  65. {%- if self.comments()|trim %}
  66. <div class="articleComments">
  67. {%- block comments %}{% endblock %}
  68. </div>
  69. {%- endif%}
  70. </div>
  71. {%- endblock %}