Ιστολόγια
Συμπεριλαμβάνοντας, για να χρησιμοποιήσετε τη συνάρτηση enumerate() της documentPython που εξαρτάται από το εσωτερικό, μπορείτε να την προσθέσετε σε ένα από τα δεδομένα πηγής σας. Τώρα που έχετε προσθέσει κάποια αρχεία και άρθρα, ας δημιουργήσουμε μια αρχική έκδοση από το docs. Τα έγγραφα που θα προστεθούν δίνονται ως ονόματα εγγράφων, τα οποία με λίγα λόγια σημαίνουν ότι βγαίνετε από την επέκταση της ετικέτας αρχείου και χρησιμοποιείτε καθέτους(/) ως διαχωριστές ευρετηρίου. Αυτό είναι ένα από τα κύρια σημεία που το Sphinx προσθέτει το reStructuredText, έναν τρόπο σύνδεσης πολλαπλών εγγράφων σε ένα βήμα από τα αρχεία. Δημιούργησε έναν εξαιρετικό κατάλογο πηγής με το conf.py και θα έχετε ένα αρχείο ρίζας, το directory.rst.
Οικοδόμοι¶
Η πιο χρησιμοποιούμενη μονάδα για την εγκατάσταση πακέτων από το PyPI είναι το pip, το οποίο χρησιμοποιείται σε όλες τις σύγχρονες εκδόσεις της Python. Αυτό θα εμφανίσει τον νέο αριθμό εκδόσεων του Sphinx. Ωστόσο, το conf.py μπορεί επίσης να εμφανιστεί σε μια άλλη λίστα, τη νέα λίστα εκδόσεων. Sphinx.ext.intersphinx για όλη τη δυσλειτουργία των λειτουργιών του intersphinx.
Για να εξερευνήσετε το intersphinx, θα πρέπει να το ενεργοποιήσετε στο conf.py τοποθετώντας τη νέα συμβολοσειρά 'sphinx.ext.intersphinx' στη λίστα επεκτάσεων και να την ορίσετε στη ρύθμιση παραμέτρων intersphinx_mapping. Το Sphinx υποστηρίζει την τελευταία εισαγωγή του docstrings από τα τμήματα σας με μια επέκταση (μια επέκταση είναι μια εξαιρετική ενότητα Python που παρέχει πρόσθετες δυνατότητες για τα έργα Sphinx) με τίτλο autodoc. Το νέο αρχείο αποθηκεύεται αυτόματα στο UTF-8, όπως ορίζεται από τη δήλωση κωδικοποίησης στην πρώτη γραμμή. Λάβετε υπόψη ότι το νεότερο έγγραφο χρησιμοποιεί σύνταξη Python για να έχει συμβολοσειρές, αριθμούς, λίστες κ.λπ. Για να προσαρμόσετε μια τιμή διαμόρφωσης που δεν είναι άμεσα επιπλέον από το sphinx-quickstart, απλώς προσθέστε μια πρόσθετη εργασία. Domains για όλα τα διαθέσιμα ονόματα τομέα και τις οδηγίες/θέσεις τους.
Πρώτη διαμόρφωση¶
Αυτά μπορούν να διεξαχθούν εκτελώντας την εντολή create στον Immerion casino μπόνους σύνδεσης όρο του δημιουργού. (Θα μπορούσαν να περιλαμβάνουν τις ίδιες τις οδηγίες toctree, πράγμα που σημαίνει ότι μπορείτε να δημιουργήσετε ένθετες ιεραρχίες εάν είναι απαραίτητο.) Και, η Sphinx τώρα γνωρίζει για την αγορά και μπορείτε να κάνετε βήματα στα έγγραφα. Έτσι εμφανίζεται το toctree για τα έγγραφα της. Κάθε οδηγία καθορίζει εάν θα την κάνει ή όχι πλήρη και εσείς θα ξέρετε πώς να τη χειριστείτε μέσα σε αυτήν.
Πακέτο Conda¶
Μπορείτε να το κάνετε αυτό μέσω του make all the-pdf about the-pdf. Για να συνδυάσετε και τις δύο συμβουλές, εξερευνήστε το sphinx-create -M(we.elizabeth. -Meters latexpdf ίσως όχι -b latexpdf) ή δημιουργήστε latexpdf στον πηγαίο κώδικα του έργου. Έτσι, το πρόγραμμα δημιουργίας it παράγει την ίδια απόδοση με το αυτόνομο πρόγραμμα δημιουργίας HTML, αλλά δημιουργεί επίσης ένα εντυπωσιακό πρόγραμμα-πελάτη δήλωσης epub. Έτσι, το πρόγραμμα δημιουργίας it παράγει την ίδια απόδοση με το αυτόνομο πρόγραμμα δημιουργίας HTML, αλλά δημιουργεί επίσης ένα αρχείο υποστήριξης GNOME Devhelp που επιτρέπει στο νέο πρόγραμμα προβολής GNOME Devhelp να έχει πρόσβαση σε αυτό.
Το Toctree είναι στην πραγματικότητα μια καλή οδηγία reStructuredText, ένα πολύ ευέλικτο κομμάτι σήμανσης. Ο στόχος του αρχείου it θα πρέπει να είναι να σας δώσει μια απλή ιδέα για το τι ακριβώς είναι το Sphinx και πώς μπορείτε να το χρησιμοποιήσετε.
Δόσεις μακριά από την πηγή¶
Σε αντίθεση με άλλα αρχεία pickle, το οποίο αρχείο pickle απαιτεί το νέο πακέτο sphinx να βρίσκεται στο unpickle σας. Αυτό είναι πάντα ένα καλό αρχείο pickle, ξεχωριστό από το thebuilder και μπορείτε να έχετε ένα αντίγραφο του δικού σας οικοσυστήματος που χρησιμοποιήθηκε όταν ξεκίνησε το builder. Το όνομα του αρχείου παροχής σας είναι μικρότερο από _supply.
Αν κάνετε αυτά τα είδη αρχείων ανιχνεύσιμα που έχουν location_dirs που ταιριάζουν στη γλώσσα σας, το Sphinx θα τα εντοπίσει αυτόματα. Το Sphinx τα εξάγει μέσω κλήσης από το sphinx-build -Meters gettext. Αντιστοιχίζουν αφελώς κείμενα μέσα σε ένα μάθημα, ώστε να έχετε μια μεταφρασμένη συμβολοσειρά. Το Sphinx χρησιμοποιεί αυτήν την υπηρεσία για να τροποποιήσει ολόκληρα αρχεία δεδομένων. Συμπληρωματικά για τις μεταφράσεις που παρέχονται για κείμενα που δημιουργούνται από το Sphinx, όπως γραμμές πλοήγησης, το Sphinx παρέχει στοιχεία που βοηθούν στη νέα μετάφραση εγγράφων. Έναν κατάλογο που μπορείτε να χρησιμοποιήσετε για να αναζητήσετε τα πιο πρόσφατα έγγραφα.
Στοιχεία δημιουργού σειριοποίησης¶
Μπορείτε να χρησιμοποιήσετε τον δικό σας διακομιστή ιστού για να διακομίσετε έγγραφα HTML Sphinx. Είναι η εναλλακτική λύση που σας προσφέρει μεγαλύτερη ανεξαρτησία και πολύ μεγαλύτερη πολυπλοκότητα. Η Αναζήτηση Εγγράφων είναι μια διαδικτυακή υπηρεσία που ειδικεύεται στη διατήρηση τεχνικής τεκμηρίωσης γραμμένης σε Sphinx, καθώς και σε MkDocs. Υπάρχει μια εξαιρετική σελίδα μετάφρασης Sphinx για να έχετε αρχεία Sphinx (κύρια).