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

Add a warning that docs are WIP and a status flag for articles

Browse Source 
By default (no flag) articles are considered up-to-date, with the end goal to have no
articles marked as outdated.
Use `:article_outdated: True` at the top of an article to mark it as being outdated.
This commit is contained in:
Yuri Sizov
2023-02-24 20:49:31 +01:00
parent c51ccca5f0
commit ff4f111677
3 changed files with 67 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
conf.py
View File

@@ -178,6 +178,9 @@ html_context = {
# Set this to `True` when in the `latest` branch to clearly indicate to the reader
# that they are not reading the `stable` documentation.
"godot_is_latest": True,
"godot_version": "4.0",
# Enables a banner that displays the up-to-date status of each article.
"godot_show_article_status": True,
}
html_logo = "img/docs_logo.svg"
@@ -192,14 +195,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?7", # Increment the number at the end when the file changes to bust the cache.
"css/custom.css?8", # 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?4", # Increment the number at the end when the file changes to bust the cache.
"js/custom.js?5", # 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'})
]