Files
godot-docs-l10n/sphinx/templates/contributing/documentation/building_the_manual.pot
2025-02-07 13:19:51 +01:00

147 lines
6.2 KiB
Plaintext

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0)
# This file is distributed under the same license as the Godot Engine package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Godot Engine 4.3\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../docs/contributing/documentation/building_the_manual.rst:4
msgid "Building the manual with Sphinx"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:6
msgid "This page explains how to build a local copy of the Godot manual using the Sphinx docs engine. This allows you to have local HTML files and build the documentation as a PDF, EPUB, or LaTeX file, for example."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:10
msgid "Before you get started, make sure that you have:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:12
msgid "`Git <https://git-scm.com/>`_"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:13
msgid "`make <https://www.gnu.org/software/make/>`_ (unless you're using Windows)"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:14
msgid "`Python <https://www.python.org/>`_ 3"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:16
msgid "Python 3 should come with the ``pip3`` command. You may need to write ``python3 -m pip`` (Unix) or ``py -m pip`` (Windows) instead of ``pip3``. If both approaches fail, `make sure that you have pip3 installed <https://pip.pypa.io/en/stable/installation/>`__."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:21
msgid "*(Optional)* Set up a virtual environment. Virtual environments prevent potential conflicts between the Python packages in ``requirements.txt`` and other Python packages that are installed on your system."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:25
msgid "Create the virtual environment:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:29
#: ../../docs/contributing/documentation/building_the_manual.rst:45
#: ../../docs/contributing/documentation/building_the_manual.rst:61
#: ../../docs/contributing/documentation/building_the_manual.rst:145
msgid "Windows"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:35
#: ../../docs/contributing/documentation/building_the_manual.rst:51
#: ../../docs/contributing/documentation/building_the_manual.rst:67
#: ../../docs/contributing/documentation/building_the_manual.rst:151
msgid "Other platforms"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:41
msgid "Activate the virtual environment:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:57
msgid "*(Optional)* Update pre-installed packages:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:73
msgid "Clone the docs repo:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:79
msgid "Change directory into the docs repo:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:85
msgid "Install the required packages:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:91
msgid "Build the docs:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:98
msgid "On Windows, that command will run ``make.bat`` instead of GNU Make (or an alternative)."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:100
msgid "Alternatively, you can build the documentation by running the sphinx-build program manually:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:106
msgid "The compilation will take some time as the ``classes/`` folder contains hundreds of files. See :ref:`doc_building_the_manual:performance`."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:109
msgid "You can then browse the documentation by opening ``_build/html/index.html`` in your web browser."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:113
msgid "Dealing with errors"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:115
msgid "If you run into errors, you may try the following command:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:121
msgid "If you get a ``MemoryError`` or ``EOFError``, you can remove the ``classes/`` folder and run ``make`` again. This will drop the class references from the final HTML documentation but will keep the rest intact."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:127
msgid "If you delete the ``classes/`` folder, do not use ``git add .`` when working on a pull request or the whole ``classes/`` folder will be removed when you commit. See `#3157 <https://github.com/godotengine/godot-docs/issues/3157>`__ for more detail."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:134
msgid "Hints for performance"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:137
msgid "RAM usage"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:139
msgid "Building the documentation requires at least 8 GB of RAM to run without disk swapping, which slows it down. If you have at least 16 GB of RAM, you can speed up compilation by running:"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:157
msgid "You can use ``-j auto`` to use all available CPU threads, but this can use a lot of RAM if you have a lot of CPU threads. For instance, on a system with 32 CPU threads, ``-j auto`` (which corresponds to ``-j 32`` here) can require 20+ GB of RAM for Sphinx alone."
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:163
msgid "Specifying a list of files"
msgstr ""
#: ../../docs/contributing/documentation/building_the_manual.rst:165
msgid "You can specify a list of files to build, which can greatly speed up compilation:"
msgstr ""