Κατασκευή Τεκμηρίωσης
Αυτό το έγγραφο εξηγεί πώς να κατασκευάσετε την τεκμ
Σημείωση
Το Parrot βρίσκεται σε πρωινή ανάπτυξη, δεν είναι έτοιμο για τους τελικούς χρήστες.
Κείμενο οδηγιών ρύθμισης
Clone the repository: First, clone the repository using this command:
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
Αλλαγή καταλόγου στην βάση δεδομένων του αφθορίσματος: Μετά την κλωνοποίηση, περιηγήθηκε στ
cd parrot-wtf
Εγκατάσταση python3-venv (apt): Αυτό χρειάζεται για να δημιουργήσετε ένα εικονικό περιβάλλον. Εκτελέ
sudo apt update sudo apt install docutils gettext python3-pip python3-venv # To build PDFs with LaTeX sudo apt install texlive-full xindy
Ορισμός ενός εικονικού περιβάλλοντος (venv): Ναυίγησε στον κatalogo αρχής του έργου σου και εκτελέσ
python3 -m venv venv
Ενεργοποίησε το virtual environment: Πριν εγκαταστήσεις οποιαδήποτε πακέτα, ενεργοποιήστε το virtual environment εκτελώντας:
source venv/bin/activate
Χρησιμοποιήστε το requirements.txt: Αυτό το αρχείο περιέχει μια λίστα απαιτήσεων έργου. Για να τα εγκατα
pip install -r requirements.txt
Εγκατάσταση Υπομονάδων: Κατεβάστε άλλες υπομονάδες αποθετηρίου Parrot για να συμπεριλάβετε τη τεκμηρ
pip install -r datasets/requirements.txt pip install -r extension/requirements.txt pip install -r ide/requirements.txt pip install -r models/requirements.txt pip install -e datasets
Κατασκευή της Τεκμηρίωσης
Εκκαθάριση υπάρχοντος μετάβασης: Αν έχετε ήδη φτιάξει την τεκμηρίωση, ξεκινήστε καθαρ
make clean
Δόμησε την HTML έκδοση των τεκμηρίωσεων: Το παράθυρο χρήσης Parrot χρησιμοποιεί το Sphinx για
make html
Other useful ``make`` commands: There are other
make
commands available in theMakefile
. You can view them by running:make help
Αποστολή σε διακομιστή στον Διαδικτύου
Μετά την δημιουργία της τεκμηρίωσης, θα βρείτε τα αρχεία HTML στον κατάλογο build/html
. Αυ
Επεξεργαστείτε .env για να ορίσετε την διεύθυνση διακομιστή που θα χρησιμοποιείται από το rsync
URL="parrot.wtf:/var/www/html/parrot-wtf/"
Εκτελέστε την ακόλουθη εντολή για να rsync
στον διακομιστή:
./scripts/rsync-parrot-wtf
Αυτό θα τροφοδοτήσει όλα τα αρχεία HTML στον «build/html» στον κεντρικό server σας.
Σημείωση
Η τεκμηρίωση του Parrot εγγράφεται σε Αγγλική και χρησιμοποιεί μηχανές μετάφρασης αισθητήρα έργου για