# SOME DESCRIPTIVE TITLE. # Copyright (C) 2014-2022, 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 , YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: Godot Engine 3.5\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2022-09-09 16:03+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: ../../docs/community/contributing/building_the_manual.rst:4 msgid "Building the manual with Sphinx" msgstr "" #: ../../docs/community/contributing/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/community/contributing/building_the_manual.rst:10 msgid "To get started, you need to:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:12 msgid "Clone the `godot-docs repository `__." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:13 msgid "Install `Sphinx `__" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:14 msgid "To build the docs as HTML files, install the `readthedocs.org theme `__." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:16 msgid "Install the Sphinx extensions defined in the `godot-docs repository `__ ``requirements.txt`` file." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:19 msgid "We recommend using `pip `__, Python’s package manager to install all these tools. It comes pre-installed with `Python `__. Ensure that you install and use Python 3. Here are the commands to clone the repository and then install all requirements." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:24 msgid "You may need to write ``python3 -m pip`` (Unix) or ``py -m pip`` (Windows) instead of ``pip3``. If both approaches fail, `check that you have pip3 installed `__." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:33 msgid "With the programs installed, you can build the HTML documentation from the root folder of this repository with the following command:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:44 msgid "If you run into errors, you may try the following command:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:50 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/community/contributing/building_the_manual.rst:62 msgid "The compilation will take some time as the ``classes/`` folder contains hundreds of files." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:65 msgid "You can then browse the documentation by opening ``_build/html/index.html`` in your web browser." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:68 msgid "In case you of 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/community/contributing/building_the_manual.rst:72 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 `__ for more detail." msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:78 msgid "Alternatively, you can build the documentation by running the sphinx-build program manually:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:85 msgid "You can also specify a list of files to build, which can greatly speed up compilation:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:92 msgid "Building with Sphinx and virtualenv" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:94 msgid "If you want your Sphinx installation scoped to the project, you can install sphinx-build using virtualenv. To do so, run this command from this repository's root folder:" msgstr "" #: ../../docs/community/contributing/building_the_manual.rst:104 msgid "Then, run ``make html`` as shown above." msgstr "" #: ../../docs/:0 msgid "Translation status" msgstr ""