Skip to content

Commit

Permalink
Merge pull request #7 from blazium-engine/TestDocCompile
Browse files Browse the repository at this point in the history
Test doc compile
  • Loading branch information
Starkium authored Oct 16, 2024
2 parents 5078c12 + 34b36d7 commit af59be5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
16 changes: 8 additions & 8 deletions conf.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -224,7 +224,7 @@
]

# Output file base name for HTML help builder
htmlhelp_basename = "GodotEnginedoc"
htmlhelp_basename = "BlaziumEnginedoc"

# -- Options for reStructuredText parser ----------------------------------

Expand All @@ -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",
),
]
Expand Down
15 changes: 8 additions & 7 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:allow_comments: False

Blazium Chat – *4.3* branch
Blazium Docs – *4.3* branch
============================

.. only:: not i18n
Expand All @@ -14,6 +14,7 @@ Blazium Chat – *4.3* branch
.. note:: This documentation is translated from the `original English one
<https://docs.godotengine.org/en/stable>`_ by community members
on `Weblate <https://hosted.weblate.org/projects/godot-engine/godot-docs>`_.
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
Expand Down Expand Up @@ -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 <https://github.com/blazium-engine/blazium-docs/issues>`_,
help us `translate the documentation <https://hosted.weblate.org/engage/godot-engine/>`_
into your language, or talk to us on the ``#documentation`` channel on the
`Godot Contributors Chat <https://chat.blazium.app/>`_!
We haven't set up translated docs yet, so either submit an issue or pull request on the `GitHub repository <https://github.com/blazium-engine/blazium-docs/issues>`_
or check the `Godot translated documentation <https://hosted.weblate.org/engage/godot-engine/>`_.
Help them and us translate docs into your language over there or talk to us on the ``#documentation`` channel on the
`Blazium Discord <https://chat.blazium.app/>`_!

.. centered:: |weblate_widget|

Offline documentation
---------------------

To browse the documentation offline, you can download an HTML copy (updated every Monday): `stable <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip>`__, `latest <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip>`__, `3.6 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-3.6.zip>`__. 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 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip>`__, `latest <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip>`__, `3.6 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-3.6.zip>`__. 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 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-stable.zip>`__, `latest <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip>`__, `3.6 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-3.6.zip>`__. 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 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-stable.zip>`__, `latest <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip>`__, `3.6 <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-3.6.zip>`__. 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.
Expand Down

0 comments on commit af59be5

Please sign in to comment.