Διεθνοποίηση

Έτσι, για να τεκμηριώσετε το κέντρο της Python μέσα στη φόρμα enumerate(), θα το τοποθετήσετε σε ένα από τα δεδομένα πηγής σας. Τώρα που έχετε προσθέσει συγκεκριμένα έγγραφα και θα έχετε περιεχόμενο, ας δημιουργήσουμε μια αρχική δημιουργία μακριά από τα έγγραφα. Τα έγγραφα που πρέπει να συμπεριληφθούν δίνονται από τις ετικέτες αρχείων, που σημαίνει ότι βγαίνετε από την επέκταση του όρου του αρχείου και κάνετε πρόβα δίνουν κάθετες(/) επειδή τα διαχωριστικά καταλόγου. Αυτό μπορεί να είναι ένα από τα σημεία που το Sphinx συμβάλλει στο reStructuredText, ένα μέσο για τη σύνδεση πολλών εγγράφων σε ένα μόνο βήμα μακριά από αρχεία. Έγραψε έναν εξαιρετικό κατάλογο προέλευσης με conf.py και έγγραφο a-root, index.rst.

οικοδόμοι¶

Το πιο δημοφιλές εργαλείο για την κατοχή πακέτων εγκατάστασης από το PyPI είναι το pip, το οποίο βρίσκεται σε όλα τα προοδευτικά μοντέλα της Python. Αυτό θα εκτυπώσει τον ολοκαίνουργιο αριθμό τύπου Sphinx. Ωστόσο, όχι, το conf.py μπορεί να ζωντανέψει σε μια άλλη λίστα, τον πιο πρόσφατο κατάλογο ρυθμίσεων. Sphinx.ext.intersphinxγια την πλήρη δυσλειτουργία των χαρακτηριστικών του intersphinx.

Για να παίξετε με το intersphinx, θα πρέπει να το ενεργοποιήσετε μέσα στο conf.py βάζοντας την ολοκαίνουργια ακολουθία ‘sphinx.ext.intersphinx’ για τη λίστα επεκτάσεων και να την ορίσετε εντός της τιμής διαμόρφωσης intersphinx_mapping. Το Sphinx υποστηρίζει τη νέα εισαγωγή εγγράφων από τις δικές σας μονάδες που έχουν μια επέκταση (μια επέκταση δοκιμάστε μια μεγάλη Pythonmodule που δίνει πρόσθετες δυνατότητες στα δικά σας έργα Sphinx) που ονομάζεται autodoc. Το νέο έγγραφο προστατεύεται στην πραγματικότητα μέσα στο UTF-8 αυτόματα, αφού εκφράζεται από τη δήλωση κωδικοποίησης στην 1η γραμμή. Λάβετε υπόψη ότι το νέο αρχείο χρησιμοποιεί σύνταξη Python για αλυσίδα, ποσά, λίστες και ούτω καθεξής για το. Προσαρμόστε μια εξαιρετική ρύθμιση παραμέτρων που αξίζει τον κόπο που δεν είναι άμεσα επιπλέον bysphinx-quickstart, συμπεριλάβετε μόνο ένα επιπλέον έργο. Τομείς για όλα τα διαθέσιμα ονόματα τομέα καθώς και τις οδηγίες/θέσεις εργασίας τους.

Πολύ πρώτη διαμόρφωση¶

Αυτά μπορούν να πραγματοποιηθούν με το τρέξιμο στο όνομα του δημιουργού κάποιου. (Θα μπορούσαν να περιλαμβάνουν τις ίδιες οδηγίες toctree, μπορείτε να δημιουργήσετε βαθιές ένθετες ιεραρχίες εάν είναι απαραίτητο.) Επίσης, η Sphinx σήμερα γνωρίζει για τη σειρά και θα αναβαθμίσετε τα δικά σας αρχεία δεδομένων. Αυτό μπορεί να είναι το toctree για τα αρχεία φαίνεται. Κάθε οδηγία καθορίζει αν θα επιτρέπεται να είναι ιστολόγια και μπορείτε να κάνετε τι να κάνετε μέσα.

πακέτο Conda¶

Αυτό μπορεί να γίνει viamake the-pdf εκεί. Για να συνδυάσετε και τις δύο διαδικασίες με τη μία, εξερευνήστε τη δημιουργία -M(δηλαδή – Bruce Bet μπόνους εγγραφής Yards latexpdf όχι -b latexpdf) ή δημιουργήστε latexpdf στους πόρους του έργου. Το πρόγραμμα δημιουργίας παρέχει παρόμοιο αποτέλεσμα με το αυτόνομο πρόγραμμα δημιουργίας HTML, αλλά δημιουργεί επίσης ένα πρόγραμμα-πελάτη ebook με δήλωση epub. Ότι το πρόγραμμα δημιουργίας παρέχει την ίδια αποτελεσματικότητα επειδή ο αυτόνομος δημιουργός HTML, αλλά δημιουργεί επίσης έγγραφο υποστήριξης προγραμματιστών GNOME που επιτρέπει στο νέο πρόγραμμα προβολής του GNOME Devhelp να έχει πρόσβαση σε αυτόν ή σε αυτόν.

Το Toctree είναι μια οδηγία ReStructuredText, ένα απίστευτα ευέλικτο κομμάτι σήμανσης. Η πρόθεση αυτού του εγγράφου είναι να σας δώσει μια άμεση γεύση του τι είναι η Σφίγγα και πώς μπορείτε να τη χρησιμοποιήσετε.

Εγκατάσταση πόρων¶

Σε αντίθεση με τα άλλα αρχεία δεδομένων τουρσί, ποιο έγγραφο τουρσί απαιτεί ότι το νεότερο πακέτο sphinx μπορεί να βρεθεί στο ξεπήξιμο. Αυτό είναι πραγματικά πάντα ένα καλό έγγραφο τουρσί, ανεξάρτητο από τον κατασκευαστή και μπορείτε να έχετε ένα αντίγραφο του δικού σας περιβάλλοντος που χρησιμοποιήθηκε σε περίπτωση που ο δημιουργός είχε ξεκινήσει. Το όνομα του αρχείου προέλευσης χαμηλότερο από _source.

Εάν κάνετε αυτούς τους τύπους αρχείων ανιχνεύσιμους έχοντας area_dirs που ταιριάζουν στον κώδικά σας, το Sphinxw θα τα πάρει αυτόματα. Η Σφίγγα εξάγει αυτά λόγω της επίκλησης του Sphinx-generate -Meters gettext. Καταγράφει αφελώς μηνύματα μέσα σε ένα μάθημα προκειμένου να μετατραπεί σε μια ακολουθία. Το Sphinx χρησιμοποιεί ένα τέτοιο ίδρυμα για να σας βοηθήσει να αλλάξετε ολόκληρα αρχεία δεδομένων. Υποχείριο για να σας βοηθήσει μεταφράσεις που αποστέλλονται σε μηνύματα που παράγονται από τη Σφίγγα, όπως ταβέρνες πλοήγησης, το Sphinx φέρνει στοιχεία που διευκολύνουν την ολοκαίνουργια ερμηνεία των εγγράφων. Ένας κατάλογος που μπορείτε να χρησιμοποιήσετε για την αναζήτηση των νέων αρχείων.

Πληροφορίες δημιουργού σειριοποίησης¶

Μπορείτε πάντα να χρησιμοποιήσετε το δικό σας μηχάνημα δικτύου για να σας βοηθήσει να επεξεργαστείτε έγγραφα HTML Sphinx. Είναι η εναλλακτική που παρέχει πολύ περισσότερη ελευθερία και επίσης πολύ μεγαλύτερη πολυπλοκότητα. Περιηγηθείτε στα Έγγραφα δοκιμάστε μια διαδικτυακή υπηρεσία με επίκεντρο την τεκμηρίωση τεχνικής τεκμηρίωσης που είναι εκτυπωμένη σε Sphinx, μαζί με το MkDocs. Υπάρχει μια καλή ιστοσελίδα ερμηνείας Sphinx για να έχετε εγγραφές Sphinx (κύριοι).