godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Display Godot version more clearly

Browse Source
This commit is contained in:
Yuri Sizov
2023-03-02 20:19:50 +01:00
parent 956810f61a
commit d14d924470
6 changed files with 57 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
_static/css/custom.css
View File

@@ -1601,6 +1601,7 @@ p + .classref-constant {
overflow-y: auto;
overflow-x: hidden;
max-height: calc(100% - 348px);
padding-bottom: 24px;
}
@media screen and (max-width: 768px) {
.wy-nav-side {

6
_static/js/custom.js
View File

@@ -13,11 +13,11 @@ const registerOnScrollEvent = (function(){
// The number of pixels the user must scroll by before the logo is completely hidden.
const scrollTopPixels = 84;
// The target margin to be applied to the navigation bar when the logo is hidden.
const menuTopMargin = 88;
const menuTopMargin = 70;
// The max-height offset when the logo is completely visible.
const menuHeightOffset_default = 180;
const menuHeightOffset_default = 162;
// The max-height offset when the logo is completely hidden.
const menuHeightOffset_fixed = 98;
const menuHeightOffset_fixed = 80;
// The distance between the two max-height offset values above; used for intermediate values.
const menuHeightOffset_diff = (menuHeightOffset_default - menuHeightOffset_fixed);

47
_templates/breadcrumbs.html
View File

@@ -1,25 +1,40 @@
{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
{% block breadcrumbs %}
<li>
<div style="font-size: 105%;font-weight: 600;">
{{ godot_docs_title | replace("%s", godot_version) }}
</div>
<ul class="wy-breadcrumbs">
{{ super() }}
</ul>
</li>
{% endblock %}
{% block breadcrumbs_aside %}
{% if not meta or meta.get('github_url') != 'hide' %}
{{ super() }}
<li style="float: right; text-align: right;">
<ul>
{{ super() }}
</ul>
<style>
.godot-edit-guidelines {
font-size: 14px;
float: right;
clear: both;
padding-top: 4px;
}
@media screen and (max-width: 480px) {
<style>
.godot-edit-guidelines {
display: none;
font-size: 14px;
float: right;
clear: both;
padding-top: 4px;
}
}
</style>
<a class="godot-edit-guidelines" href="https://docs.godotengine.org/en/latest/contributing/documentation/index.html#writing-documentation">
Learn how to contribute!
</a>
@media screen and (max-width: 480px) {
.godot-edit-guidelines {
display: none;
}
}
</style>
<a class="godot-edit-guidelines" href="https://docs.godotengine.org/en/latest/contributing/documentation/index.html#writing-documentation">
Learn how to contribute!
</a>
</li>
{% endif %}
{% endblock %}

1
_templates/layout.html
View File

@@ -1,4 +1,5 @@
{% extends "!layout.html" -%}
{# Refer to https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html #}
{% block htmltitle -%}
<title>{{ godot_title_prefix }}{{ title|striptags|e }}{{ titlesuffix }}</title>

2
_templates/versions.html
View File

@@ -13,7 +13,7 @@
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: {{ display_version }}
v: {{ display_version }}{% if display_version != godot_version %} ({{ godot_version }}){% endif %}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">

37
conf.py
View File

@@ -97,20 +97,20 @@ if env_tags is not None:
# Language / i18n
supported_languages = {
"en": "Godot Engine (%s) documentation in English",
"de": "Godot Engine (%s) Dokumentation auf Deutsch",
"es": "Documentación de Godot Engine (%s) en español",
"fr": "Documentation de Godot Engine (%s) en français",
"fi": "Godot Engine (%s) dokumentaatio suomeksi",
"it": "Godot Engine (%s) documentazione in italiano",
"ja": "Godot Engine (%s)の日本語のドキュメント",
"ko": "Godot Engine (%s) 문서 (한국어)",
"pl": "Dokumentacja Godot Engine (%s) w języku polskim",
"pt_BR": "Documentação da Godot Engine (%s) em Português Brasileiro",
"ru": "Документация Godot Engine (%s) на русском языке",
"uk": "Документація до Godot Engine (%s) українською мовою",
"zh_CN": "Godot Engine (%s) 简体中文文档",
"zh_TW": "Godot Engine (%s) 正體中文 (台灣) 文件",
"en": "Godot Engine %s documentation in English",
"de": "Godot Engine %s Dokumentation auf Deutsch",
"es": "Documentación de Godot Engine %s en español",
"fr": "Documentation de Godot Engine %s en français",
"fi": "Godot Engine %s dokumentaatio suomeksi",
"it": "Godot Engine %s documentazione in italiano",
"ja": "Godot Engine %sの日本語のドキュメント",
"ko": "Godot Engine %s 문서 (한국어)",
"pl": "Dokumentacja Godot Engine %s w języku polskim",
"pt_BR": "Documentação da Godot Engine %s em Português Brasileiro",
"ru": "Документация Godot Engine %s на русском языке",
"uk": "Документація до Godot Engine %s українською мовою",
"zh_CN": "Godot Engine %s 简体中文文档",
"zh_TW": "Godot Engine %s 正體中文 (台灣) 文件",
}
language = os.getenv("READTHEDOCS_LANGUAGE", "en")
@@ -155,9 +155,11 @@ html_theme_options = {
"logo_only": True,
# Collapse navigation (False makes it tree-like)
"collapse_navigation": False,
# Hide the documentation version name/number under the logo
"display_version": False,
}
html_title = supported_languages[language] % version
html_title = supported_languages[language] % ( "(" + version + ")" )
# VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github
html_context = {
@@ -168,6 +170,7 @@ html_context = {
"conf_py_path": "/", # Path in the checkout to the docs root
"godot_inject_language_links": True,
"godot_docs_supported_languages": list(supported_languages.keys()),
"godot_docs_title": supported_languages[language],
"godot_docs_basepath": "https://docs.godotengine.org/",
"godot_docs_suffix": ".html",
"godot_default_lang": "en",
@@ -195,14 +198,14 @@ html_extra_path = ["robots.txt"]
html_css_files = [
'css/algolia.css',
'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css',
"css/custom.css?9", # Increment the number at the end when the file changes to bust the cache.
"css/custom.css?10", # Increment the number at the end when the file changes to bust the cache.
]
if not on_rtd:
html_css_files.append("css/dev.css")
html_js_files = [
"js/custom.js?5", # Increment the number at the end when the file changes to bust the cache.
"js/custom.js?6", # Increment the number at the end when the file changes to bust the cache.
('https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js', {'defer': 'defer'}),
('js/algolia.js', {'defer': 'defer'})
]