Skip to content

Commit

Permalink
Merge pull request #17 from adikhoff/stable
Browse files Browse the repository at this point in the history
Improve performance of builds
  • Loading branch information
adikhoff authored Oct 12, 2024
2 parents ac5aa05 + 7768f31 commit b284df2
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 454 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_offline_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
python migrate.py . _migrated False
- name: Sphinx - Build HTML
run: make SPHINXOPTS='--color' SPHINXSOURCEDIR='./_migrated' html
run: make SPHINXOPTS='--color -j 4' SPHINXSOURCEDIR='./_migrated' html

- uses: actions/upload-artifact@v4
with:
Expand All @@ -53,7 +53,7 @@ jobs:
sed -i 's/"redot_is_latest": True/"redot_is_latest": False/' conf.py
sed -i 's/"redot_show_article_status": True/"redot_show_article_status": False/' conf.py
make SPHINXOPTS='--color' SPHINXSOURCEDIR='./_migrated' epub
make SPHINXOPTS='--color -j 4' SPHINXSOURCEDIR='./_migrated' epub
- uses: actions/upload-artifact@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ jobs:
# Use dummy builder to improve performance as we don't need the generated HTML in this workflow.
- name: Sphinx build
run: make SPHINXOPTS='--color -W' SPHINXSOURCEDIR='./_migrated' dummy
run: make SPHINXOPTS='--color -W -j 4' SPHINXSOURCEDIR='./_migrated' dummy
2 changes: 0 additions & 2 deletions classes/class_editorsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2543,8 +2543,6 @@ Tab style of editor docks.

The language to use for the editor interface.

Translations are provided by the community. If you spot a mistake, :doc:`contribute to editor translations on Weblate! <../contributing/documentation/editor_and_docs_localization>`

.. rst-class:: classref-item-separator

----
Expand Down
15 changes: 0 additions & 15 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -304,20 +304,5 @@ def godot_get_image_filename_for_language(filename, env):

os.symlink("../classes/" + language, "classes")

# Couldn't find a way to retrieve variables nor do advanced string
# concat from reST, so had to hardcode this in the "epilog" added to
# all pages. This is used in index.rst to display the Weblate badge.
# On English pages, the badge points to the language-neutral engage page.
rst_epilog = """
.. |weblate_widget| image:: https://hosted.weblate.org/widgets/godot-engine/{image_locale}/godot-docs/287x66-white.png
:alt: Translation status
:target: https://hosted.weblate.org/engage/godot-engine{target_locale}/?utm_source=widget
:width: 287
:height: 66
""".format(
image_locale="-" if language == "en" else language,
target_locale="" if language == "en" else "/" + language,
)

# Needed so the table of contents is created for EPUB
epub_tocscope = 'includehidden'
406 changes: 2 additions & 404 deletions contributing/documentation/editor_and_docs_localization.rst

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions contributing/how_to_contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,6 @@ Technical contributions
The documentation is one of the most essential parts of any tech project, yet the need to document new features and substantial changes often gets overlooked.
Join the `documentation team <https://chat.godotengine.org/channel/documentation>`_ to improve the Godot Engine with your technical writing skills.

- **Translations (spoken languages other than English)**
Are you interested in making the Godot Engine more accessible to non-English speakers?
Contribute to our `community-translations <https://hosted.weblate.org/projects/godot-engine/godot/>`_.

Community support
-----------------

Expand Down
26 changes: 0 additions & 26 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,6 @@
Godot Docs – *4.3* branch
============================

.. only:: not i18n

.. note:: Godot's documentation is available in various languages and versions.
Expand the "Read the Docs" panel at the bottom of the sidebar to see
the list.

.. only:: i18n

.. 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>`_.

Depending on the translation effort's completion level, you may
find paragraphs or whole pages which are still in English. You can
help the community by providing new translations or reviewing existing
ones on Weblate.

For the time being, localized translations are only available for
the "stable" branch. You can still view the English documentation for
other engine versions using the "Read the Docs" panel at the bottom
of the sidebar.

Welcome to the official documentation of `Godot Engine <https://godotengine.org>`__,
the free and open source community-driven 2D and 3D game engine! If you are new
to this documentation, we recommend that you read the
Expand All @@ -44,12 +22,8 @@ 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/godotengine/godot-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.godotengine.org/>`_!

.. centered:: |weblate_widget|

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

Expand Down
2 changes: 2 additions & 0 deletions migrate.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
('https://github.com/godotengine/godot-proposals', 'https://github.com/redot-engine/redot-proposals'),
('https://raw.githubusercontent.com/godotengine/godot-docs', 'https://raw.githubusercontent.com/redot-engine/redot-docs'),
('https://github.com/godotengine/', 'https://github.com/redot-engine/'),
('https://chat.godotengine.org/', 'https://discord.gg/a53QyHJZ'),
# Generic replacements
('GODOT_COPYRIGHT.txt', 'REDOT_COPYRIGHT.txt'),
('godot-docs', 'redot-docs'),
Expand Down Expand Up @@ -176,6 +177,7 @@
('to_godot', 'to_redot'),
('godot.html', 'redot.html'),
('by-godot', 'by-redot'),
('MadeWithGodot', 'MadeWithRedot'),
]

filename_mappings = [
Expand Down

0 comments on commit b284df2

Please sign in to comment.