diff --git a/conf.py b/conf.py index 652ea7054ae..cbd2030a7c1 100644 --- a/conf.py +++ b/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# Godot Engine documentation build configuration file +# Blazium Engine documentation build configuration file import sphinx import sphinx_rtd_theme @@ -82,9 +82,9 @@ # General information about the project project = "Blazium Engine" copyright = ( - "2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0)" + "2024-present Blazium community, 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0)" ) -author = "Juan Linietsky, Ariel Manzur and the Godot community" +author = "Blazium community, Juan Linietsky, Ariel Manzur and the Godot community" # Version info for the project, acts as replacement for |version| and |release| # The short X.Y version @@ -177,8 +177,8 @@ # VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github html_context = { "display_github": not is_i18n, # Integrate GitHub - "github_user": "godotengine", # Username - "github_repo": "godot-docs", # Repo name + "github_user": "blazium-engine", # Username + "github_repo": "blazium-docs", # Repo name "github_version": "4.3", # Version "conf_py_path": "/", # Path in the checkout to the docs root "godot_inject_language_links": True, @@ -224,7 +224,7 @@ ] # Output file base name for HTML help builder -htmlhelp_basename = "GodotEnginedoc" +htmlhelp_basename = "BlaziumEnginedoc" # -- Options for reStructuredText parser ---------------------------------- @@ -239,9 +239,9 @@ latex_documents = [ ( master_doc, - "GodotEngine.tex", + "BlaziumEngine.tex", "Blazium Engine Documentation", - "Juan Linietsky, Ariel Manzur and the Godot community", + "Blazium community, Juan Linietsky, Ariel Manzur and the Godot community", "manual", ), ] diff --git a/index.rst b/index.rst index c6dbb0e9870..97ffde79645 100644 --- a/index.rst +++ b/index.rst @@ -1,6 +1,6 @@ :allow_comments: False -Blazium Chat – *4.3* branch +Blazium Docs – *4.3* branch ============================ .. only:: not i18n @@ -14,6 +14,7 @@ Blazium Chat – *4.3* branch .. note:: This documentation is translated from the `original English one `_ by community members on `Weblate `_. + The Blazium team may or may not have it's own version. Depending on the translation effort's completion level, you may find paragraphs or whole pages which are still in English. You can @@ -43,20 +44,20 @@ tutorials and class reference. If you don't understand something, or cannot find what you are looking for in the docs, help us make the documentation better by letting us know! -Submit an issue or pull request on the `GitHub repository `_, -help us `translate the documentation `_ -into your language, or talk to us on the ``#documentation`` channel on the -`Godot Contributors Chat `_! +We haven't set up translated docs yet, so either submit an issue or pull request on the `GitHub repository `_ +or check the `Godot translated documentation `_. +Help them and us translate docs into your language over there or talk to us on the ``#documentation`` channel on the +`Blazium Discord `_! .. centered:: |weblate_widget| Offline documentation --------------------- -To browse the documentation offline, you can download an HTML copy (updated every Monday): `stable `__, `latest `__, `3.6 `__. Extract the ZIP archive then open +To browse the documentation offline, for now you can download an HTML copy from Godot (updated every Monday): `stable `__, `latest `__, `3.6 `__. Extract the ZIP archive then open the top-level ``index.html`` in a web browser. -For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): `stable `__, `latest `__, `3.6 `__. Extract the ZIP archive then open +For mobile devices or e-readers, you can also download an ePub copy from Godot (updated every Monday): `stable `__, `latest `__, `3.6 `__. Extract the ZIP archive then open the ``GodotEngine.epub`` file in an e-book reader application. .. Below is the main table-of-content tree of the documentation website.