details on language builds (#58)

pull/63/head
Dan Joseph 2020-08-05 15:22:38 -04:00 zatwierdzone przez GitHub
rodzic 5909e36e46
commit 9ca247dd20
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
2 zmienionych plików z 28 dodań i 1 usunięć

Wyświetl plik

@ -123,7 +123,9 @@ Open https://github.com/OpenDroneMap/docs and you'll see a box asking you to ope
## Contributing translations
_TODO_
Transifex has a getting [started guide for translators](https://docs.transifex.com/getting-started-1/translators) that will walk you through the steps to setup an account.
The ODM documentation Transifex project can be found at: https://www.transifex.com/americanredcross/opendronemap_docs/
## Managing the translation process
@ -160,6 +162,31 @@ tx pull -l sw
To add a new language, do it through the Transifex interface and then add a new line to the Makefile `deploy` command.
## The Travis CI build failed... 😞
Don't panic! Unfortunately, Transifex doesn't protect the reST notation that Sphinx uses for things like formatting and links. It's possible that during translation, some of the syntax was broken.
Start up your Python virtual environment if it's not already with `source venv/bin/activate` and then try a build of the language that you're trying to update, for example:
```
sphinx-build -b html -D language='sw' source "_build/html/sw/" -nW
```
The `-nW` (nitpicky) flag is important. You should see an output in your console such as:
```
Warning, treated as error:
/path/to/my/project/OpenDroneMap/docs/source/multispectral.rst:25:<translated>:1:Inline interpreted text or phrase reference start-string without end-string.
```
Look at the source file and line that is mentioned. In this case the file is `source/multispectral.rst` and the line is the number after the colon after the filename (`25`). Looking at the file we see that line 25 is the last line and the "Help edit these docs!" link.
Go to Transifex, go to the resource, and go to the string. The warning/error message should help you understand what went wrong. In this case the link syntax wasn't matched correctly. Fix and save the translation.
![Transifex screen grab](https://raw.githubusercontent.com/OpenDroneMap/docs/publish/readme-img/reST_syntax_err_transifex.png)
Pull the language down (e.g. `tx pull -l sw`) and then try the build again. Unfortunately, if there is more than one error, you'll have to fix them one at a time.
### Questions?
Reach out to https://community.opendronemap.org, we'll help you get up and running with your first contribution if you get stuck!

Plik binarny nie jest wyświetlany.

Po

Szerokość:  |  Wysokość:  |  Rozmiar: 72 KiB