doiciméid a aistriú ag baint úsáide as Sphinx¶
Is uirlis é Sphinx chun doiciméadú álainn a chruthú. Úsáideann sé comhréir shimplí reStructuredText agus féadann sé aschur a ghiniúint i go leor formáidí. Má tá sampla á lorg agat, tógtar an doiciméadú seo agus é á úsáid freisin. Is é an compánach an-úsáideach chun Sphinx a úsáid ná an tseirbhís Read the Docs, a dhéanfaidh do dhoiciméadú a thógáil agus a fhoilsiú saor in aisce.
I will not focus on writing documentation itself, if you need guidance with
that, just follow instructions on the Sphinx website. Once you have
documentation ready, translating it is quite easy as Sphinx comes with support
for this and it is quite nicely covered in their Internationalization. It's
matter of a few configuration directives and invoking the sphinx-intl
tool.
If you are using Read the Docs service, you can start building translated documentation on Read the Docs. Their Localization and Internationalization covers pretty much everything you need - creating another project, setting its language, and linking it from the main project as a translation.
Now all you need is translating the documentation content. Sphinx generates PO
file for each directory or top-level file, which can lead to quite a lot of
files to translate (depending on gettext_compact settings).
You can import the index.po into Weblate as an initial component and
then configure Fionnachtain Comhpháirte add-on to automatically
discover all others.
|
|
|
|
|
|
comhad PO gettext |
|
|
slonn rialta chun comhaid aistriúcháin a mheaitseáil le |
|
Saincheap ainm an chomhpháirt |
|
Sainmhínigh an bunchomhad le haghaidh aistriúcháin nua |
|
Hint
Arbh fhearr leat Sphinx gan ach comhad PO amháin a ghiniúint? Ós rud é Sphinx 3.3.0 is féidir leat é seo a bhaint amach ag baint úsáide as:
gettext_compact = "docs"
Is féidir leat teacht ar roinnt tionscadal doiciméadúcháin á n-aistriú ag baint úsáide as an gcur chuige seo:
Doiciméadúchán gréasáin (tá sé á léamh agat anois)