Cur le doiciméadú Weblate

Tá fáilte romhat an leathanach doiciméadaithe de do rogha féin a fheabhsú. Déan é go héasca trí chliceáil ar an gcnaipe Cuir in eagar ar GitHub sa chúinne uachtarach ar dheis den leathanach.

Treoirlínte maidir le doiciméadú

Tabhair meas ar na treoirlínte seo agus tú ag scríobh:

  1. Ná bain cuid den doiciméadú má tá sé bailí.

  2. Bain úsáid as teanga atá soiléir agus sothuigthe. Tá tú ag scríobh doiciméad teicneolaíochta, ní dán. Ní cainteoirí dúchais iad gach léitheoir doc, bí tuisceanach.

  3. Ná bíodh eagla ort fiafraí mura bhfuil tú cinnte. Má tá ort ceist a chur faoi ghné éigin agus tú ag déanamh eagarthóireachta, ná athraigh a dhoiciméid sula mbeidh an freagra agat. Ciallaíonn sé seo: Athraíonn tú nó iarrann tú. Ná déan an dá rud ag an am céanna.

  4. Fíoraigh do chuid athruithe trí ghníomhartha tuairiscithe a dhéanamh agus na doiciméid á leanúint.

  5. Seol PR le hathruithe i bpíosaí beaga chun é a dhéanamh níos éasca agus níos tapúla athbhreithniú agus cumasc a dhéanamh.

  6. Más mian leat struchtúr alt mór a athscríobh agus a athrú, déan é in dhá chéim:

    1. Athscríobh

    2. Nuair atá an athscríobh athbhreithnithe, snasta, agus cumaiscthe, athraigh struchtúr na míreanna i PR eile.

An doiciméadú a thógáil go háitiúil

Is féidir cáipéisíocht a chur in eagar agus a thógáil go háitiúil freisin, tá na riachtanais Python sa ghrúpa spleáchais docs i pyproject.toml. Is féidir an tógáil a dhéanamh ag baint úsáide as ci/run-docs.

Hint

Beidh ort freisin graphviz a shuiteáil chun an doiciméadú a thógáil.

Na cáipéisí a aistriú

Is féidir leat na doiciméid a aistriú.

Ceadanna, seiceálacha, breiseáin agus moltaí uathoibríocha a dhoiciméadú

Úsáideann roinnt rannóga doiciméadúcháin teimpléid a ghintear ón gcód. Tá na horduithe bainistíochta seo a leanas ar fáil:

Aschur na horduithe seo go léir reStructuredText a úsáidtear mar theimpléad don doiciméadú. Is é an bealach is éasca chun athruithe a chur i bhfeidhm ar an gcáipéisíocht ná diff amhairc a úsáid i d'eagarthóir.