Arpedon Documentation

Πως να συνεισφέρετε:

Θα χρειαστούν στον υπολογιστή:

• python 3.8
• poetry
• Επεξεργαστής κειμένου. Προτείνεται Visual Studio code

Σε υπολογιστή Windows

Την πρώτη φορά για να εγκαταστήσουμε τον κώδικα και τα εργαλεία.

1. Clone project

Μέσω Τερματικού ανοίγουμε το Ubuntu και πηγαίνουμε στο path όπου βρίσκονται τα project μας.

Κατεβάζουμε τον κώδικα του αποθετηρίου:

git clone git@github.com:arpedon/docs.git; cd docs

2. Install tools

Κατεβάζουμε το poetry :

sudo apt install python3 python3-poetry
poetry install

Αφού τελειώσει βοηθάει να ακολουθήσουμε τον οδηγό.

Για βρούμε το περιβάλλον και να το εισάγουμε στο Python: Select Interpreter:

poetry show -v
Using virtualenv: C:\Users\tsangiotis\AppData\Local\pypoetry\Cache\virtualenvs\arpedon-docs-ih6q2V8l-py3.8
...
...

Κάθε επόμενη φορά τα παραπάνω βήματα παραλείπονται.

3. Ξεκινώντας να γράφουμε

Ανοίγουμε το VScode και στο Terminal εκτελούμε την εντολή:

cd docs

Πρέπει να είμαστε στο φάκελο ./docs/docs του project και το εικονικό περιβάλλον python να είναι ενεργοποιημένο.

4. Build των docs στα Ελληνικά

Δημιουργούμε τα αρχεία στα Ελληνικά.

$ make -e SPHINXOPTS="-D language='el'" html

Τα δημιουργημένα αρχεία ειναι στο φάκελο _build. Πηγαίνοντας στο φάκελο αυτό ανοίγουμε το index.html και βλέπουμε το αποτέλεσμα.

5. Δημιουργία των απαιτούμενων αρχείων για μετάφραση στα Αγγλικά

Δημιουργούμε τα αρχεία εκτελώντας την παρακάτω εντολή.

sphinx-build -b gettext . _build/gettext; sphinx-intl update -p _build/gettext -l en

Τώρα τα αρχεία .po είναι στο ./locale/en/LC_MESSAGES/

6. Δημιουργία της μετάφρασης

$ make -e SPHINXOPTS="-D language='en'" html

Πλέον στο φάκελο _build τα αρχεία έχουν αντικατασταθεί με την Αγγλική έκδοση.