88msgstr ""
99"Project-Id-Version : Tarantool 3.0\n "
1010"Report-Msgid-Bugs-To : \n "
11- "POT-Creation-Date : 2023-12-20 12:25 +0000\n "
11+ "POT-Creation-Date : 2023-12-20 12:29 +0000\n "
1212"PO-Revision-Date : YEAR-MO-DA HO:MI+ZONE\n "
1313"Last-Translator : FULL NAME <EMAIL@ADDRESS>\n "
1414"
Language-Team :
LANGUAGE <[email protected] >\n "
@@ -19,259 +19,3 @@ msgstr ""
1919#: ../../doc/contributing/docs/build.rst:2
2020msgid "Building Tarantool Docs"
2121msgstr ""
22-
23- #: ../../doc/contributing/docs/_includes/README.rst:2
24- msgid "How to build Tarantool documentation using Docker"
25- msgstr ""
26-
27- #: ../../doc/contributing/docs/_includes/README.rst:4
28- msgid "See `Docker <https://www.docker.com>`_"
29- msgstr ""
30-
31- #: ../../doc/contributing/docs/_includes/README.rst:7
32- msgid "Prepare for work"
33- msgstr ""
34-
35- #: ../../doc/contributing/docs/_includes/README.rst:9
36- msgid "First of all, pull the image for building the docs."
37- msgstr ""
38-
39- #: ../../doc/contributing/docs/_includes/README.rst:11
40- msgid "docker pull tarantool/doc-builder:fat-4.3"
41- msgstr ""
42-
43- #: ../../doc/contributing/docs/_includes/README.rst:15
44- msgid "Next, initialize a Makefile for your OS:"
45- msgstr ""
46-
47- #: ../../doc/contributing/docs/_includes/README.rst:17
48- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" cmake .\" "
49- msgstr ""
50-
51- #: ../../doc/contributing/docs/_includes/README.rst:22
52- msgid "Update submodules and generate documentation sources from code"
53- msgstr ""
54-
55- #: ../../doc/contributing/docs/_includes/README.rst:24
56- msgid "A big part of documentation sources comes from several other projects, connected as Git submodules. To include their latest contents in the docs, run these two steps."
57- msgstr ""
58-
59- #: ../../doc/contributing/docs/_includes/README.rst:28
60- msgid "Update the submodules:"
61- msgstr ""
62-
63- #: ../../doc/contributing/docs/_includes/README.rst:30
64- msgid "git submodule update --init\n"
65- "git fetch --recurse-submodules\n"
66- "git submodule update --remote --checkout"
67- msgstr ""
68-
69- #: ../../doc/contributing/docs/_includes/README.rst:36
70- msgid "This will initialize Git submodules and update them to the top of the stable branch in each repository."
71- msgstr ""
72-
73- #: ../../doc/contributing/docs/_includes/README.rst:39
74- msgid "``git submodule update`` can sometimes fail, for example, when you have changes in submodules' files. You can reinitialize submodules to fix the problem."
75- msgstr ""
76-
77- #: ../../doc/contributing/docs/_includes/README.rst:43
78- msgid "**Caution:** all untracked changes in submodules will be lost!"
79- msgstr ""
80-
81- #: ../../doc/contributing/docs/_includes/README.rst:45
82- msgid "git submodule deinit -f .\n"
83- "git submodule update --init"
84- msgstr ""
85-
86- #: ../../doc/contributing/docs/_includes/README.rst:51
87- msgid "Note that there's an option to update submodule repositories with a ``make`` command. However, it's intended for use in a CI environment and not on a local machine."
88- msgstr ""
89-
90- #: ../../doc/contributing/docs/_includes/README.rst:54
91- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make pull-modules\" "
92- msgstr ""
93-
94- #: ../../doc/contributing/docs/_includes/README.rst:58
95- msgid "Build the submodules content:"
96- msgstr ""
97-
98- #: ../../doc/contributing/docs/_includes/README.rst:60
99- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make build-modules\" "
100- msgstr ""
101-
102- #: ../../doc/contributing/docs/_includes/README.rst:64
103- msgid "This command will do two things:"
104- msgstr ""
105-
106- #: ../../doc/contributing/docs/_includes/README.rst:66
107- msgid "Generate documentation source files from the source code"
108- msgstr ""
109-
110- #: ../../doc/contributing/docs/_includes/README.rst:67
111- msgid "Copy these files to the right places under the ``./doc/`` directory."
112- msgstr ""
113-
114- #: ../../doc/contributing/docs/_includes/README.rst:69
115- msgid "If you're editing submodules locally, repeat this step to view the updated results."
116- msgstr ""
117-
118- #: ../../doc/contributing/docs/_includes/README.rst:72
119- msgid "Now you're ready to build and preview the documentation locally."
120- msgstr ""
121-
122- #: ../../doc/contributing/docs/_includes/README.rst:75
123- msgid "Build and run the documentation on your machine"
124- msgstr ""
125-
126- #: ../../doc/contributing/docs/_includes/README.rst:77
127- msgid "When editing the documentation, you can set up a live-reload server. It will build your documentation and serve it on `127.0.0.1:8000 <http://127.0.0.1:8000>`_. Every time you make changes in the source files, it will rebuild the docs and refresh the browser page."
128- msgstr ""
129-
130- #: ../../doc/contributing/docs/_includes/README.rst:82
131- msgid "docker run --rm -it -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make autobuild\" "
132- msgstr ""
133-
134- #: ../../doc/contributing/docs/_includes/README.rst:86
135- msgid "First build will take some time. When it's done, open `127.0.0.1:8000 <http://127.0.0.1:8000>`_ in the browser. Now when you make changes, they will be rebuilt in a few seconds, and the browser tab with preview will reload automatically."
136- msgstr ""
137-
138- #: ../../doc/contributing/docs/_includes/README.rst:91
139- msgid "You can also build the docs manually with ``make html``, and then serve them using python3 built-in server:"
140- msgstr ""
141-
142- #: ../../doc/contributing/docs/_includes/README.rst:94
143- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make html\" \n"
144- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make html-ru\" \n"
145- "python3 -m http.server --directory output/html"
146- msgstr ""
147-
148- #: ../../doc/contributing/docs/_includes/README.rst:100
149- msgid "or python2 built-in server:"
150- msgstr ""
151-
152- #: ../../doc/contributing/docs/_includes/README.rst:102
153- msgid "cd output/html\n"
154- "python -m SimpleHTTPServer"
155- msgstr ""
156-
157- #: ../../doc/contributing/docs/_includes/README.rst:107
158- msgid "then go to `localhost:8000 <http://localhost:8000>`_ in your browser."
159- msgstr ""
160-
161- #: ../../doc/contributing/docs/_includes/README.rst:109
162- msgid "There are other commands which can run in the ``tarantool/doc-builder`` container:"
163- msgstr ""
164-
165- #: ../../doc/contributing/docs/_includes/README.rst:112
166- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make html\" \n"
167- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make html-ru\" \n"
168- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make singlehtml\" \n"
169- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make singlehtml-ru\" \n"
170- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make pdf\" \n"
171- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make pdf-ru\" \n"
172- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make json\" \n"
173- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make json-ru\" \n"
174- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make epub\" \n"
175- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make epub-ru\" \n"
176- "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make update-po\" "
177- msgstr ""
178-
179- #: ../../doc/contributing/docs/_includes/README.rst:127
180- msgid "Linkcheck"
181- msgstr ""
182-
183- #: ../../doc/contributing/docs/_includes/README.rst:129
184- msgid "There's a specific build mode which checks internal and external links instead of producing a document."
185- msgstr ""
186-
187- #: ../../doc/contributing/docs/_includes/README.rst:131
188- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make linkcheck\" "
189- msgstr ""
190-
191- #: ../../doc/contributing/docs/_includes/README.rst:135
192- msgid "If you need to save the linkcheck's report in a file, you can use the following trick:"
193- msgstr ""
194-
195- #: ../../doc/contributing/docs/_includes/README.rst:137
196- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make linkcheck\" 2>&1 | tee linkcheck.log"
197- msgstr ""
198-
199- #: ../../doc/contributing/docs/_includes/README.rst:141
200- msgid "Here ``2>&1`` redirects the ``stderr`` output to ``stdout``, and then ``tee`` both shows in on screen and writes to a file."
201- msgstr ""
202-
203- #: ../../doc/contributing/docs/_includes/README.rst:146
204- msgid "Vale"
205- msgstr ""
206-
207- #: ../../doc/contributing/docs/_includes/README.rst:148
208- msgid "Tarantool documentation uses the Vale linter for checking grammar, style, and word usage. Its configuration is placed in the ``vale.ini`` file located in the root project directory."
209- msgstr ""
210-
211- #: ../../doc/contributing/docs/_includes/README.rst:151
212- msgid "To enable RST support in Vale, you need to install Sphinx. Then, you can enable Vale integration in your IDE, for example:"
213- msgstr ""
214-
215- #: ../../doc/contributing/docs/_includes/README.rst:154
216- msgid "`VS Code <https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server>`_"
217- msgstr ""
218-
219- #: ../../doc/contributing/docs/_includes/README.rst:155
220- msgid "`IntelliJ-based IDEs <https://plugins.jetbrains.com/plugin/16136-grazie-professional/docs/project-style-guides.html#vanilla-vale>`_"
221- msgstr ""
222-
223- #: ../../doc/contributing/docs/_includes/README.rst:159
224- msgid "Localization"
225- msgstr ""
226-
227- #: ../../doc/contributing/docs/_includes/README.rst:161
228- msgid "Terms:"
229- msgstr ""
230-
231- #: ../../doc/contributing/docs/_includes/README.rst:163
232- msgid "**translation unit** (TU) is an atomic piece of text which can be translated. A paragraph, a list item, a heading, image's alt-text and so on."
233- msgstr ""
234-
235- #: ../../doc/contributing/docs/_includes/README.rst:166
236- msgid "**translation source files** are the files with translation units in English only. They're located in ``locale/en``."
237- msgstr ""
238-
239- #: ../../doc/contributing/docs/_includes/README.rst:169
240- msgid "**translation files** are the files which match original text to translated text. They're located in ``locale/ru``."
241- msgstr ""
242-
243- #: ../../doc/contributing/docs/_includes/README.rst:172
244- msgid "To update the translation files, run the `make update-po` task:"
245- msgstr ""
246-
247- #: ../../doc/contributing/docs/_includes/README.rst:174
248- msgid "docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.3 sh -c \" make update-po\" "
249- msgstr ""
250-
251- #: ../../doc/contributing/docs/_includes/README.rst:178
252- msgid "Translate the strings in the updated files and then commit the changes."
253- msgstr ""
254-
255- #: ../../doc/contributing/docs/_includes/README.rst:181
256- msgid "How to contribute"
257- msgstr ""
258-
259- #: ../../doc/contributing/docs/_includes/README.rst:183
260- msgid "To contribute to documentation, use the `REST <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ format for drafting and submit your updates as a `pull request <https://help.github.com/articles/creating-a-pull-request>`_ via GitHub."
261- msgstr ""
262-
263- #: ../../doc/contributing/docs/_includes/README.rst:189
264- msgid "To comply with the writing and formatting style, use the `guidelines <https://www.tarantool.io/en/doc/latest/contributing/docs/>`_ provided in the documentation, common sense and existing documents."
265- msgstr ""
266-
267- #: ../../doc/contributing/docs/_includes/README.rst:193
268- msgid "Notes:"
269- msgstr ""
270-
271- #: ../../doc/contributing/docs/_includes/README.rst:195
272- msgid "If you suggest creating a new documentation section (a whole new page), it has to be saved to the relevant section at GitHub."
273- msgstr ""
274-
275- #: ../../doc/contributing/docs/_includes/README.rst:198
276- msgid "If you want to contribute to localizing this documentation (for example, into Russian), add your translation strings to ``.po`` files stored in the corresponding locale directory (for example, ``/locale/ru/LC_MESSAGES/`` for Russian). See more about localizing with Sphinx at http://www.sphinx-doc.org/en/stable/intl.html."
277- msgstr ""
0 commit comments