Περιεχόμενο
Έτσι, για να σας βοηθήσουμε να τεκμηριώσετε το εξαρτημένο του Python-μέσα στη φόρμα enumerate(), θα το συμπεριλάβετε σε ένα μακριά από τα έγγραφα προέλευσης. Τώρα που έχετε προσθέσει συγκεκριμένα αρχεία και έχετε άρθρα, ας δημιουργήσουμε μια κύρια δημιουργία μακριά από τα έγγραφα. Τα έγγραφα που πρέπει να παρέχετε δίνονται επειδή τα έγγραφα είναι επώνυμα, τα οποία με λίγα λόγια βγάζετε από την επέκταση ετικέτας αρχείου και χρησιμοποιείτε κάθετες (/) ως διαχωριστικά ευρετηρίου. Αυτό μπορεί να είναι ένα από τα κύρια σημεία που το Sphinx συνεισφέρει στο reStructuredText, μια μέθοδο για τη σύνδεση πολλαπλών δεδομένων σε τουλάχιστον μία σκάλα μακριά από δεδομένα. Δημιούργησε έναν κατάλογο προέλευσης που έχει conf.py και θα a-root αρχείο, list.rst.
οικοδόμοι¶
Συνήθως η πιο δημοφιλής μονάδα για την εγκατάσταση πακέτων από το PyPI είναι στην πραγματικότητα το pip, το οποίο χρησιμοποιείται σε όλους τους προοδευτικούς τύπους Python. Αυτό θα πρέπει να εκτυπώσει τον νέο αριθμό παραλλαγών της Σφίγγας. Αλλά όχι, το conf.py μπορεί επίσης να είναι ζωντανό σε ένα άλλο ευρετήριο, την ολοκαίνουργια λίστα ρυθμίσεων. Sphinx.ext.intersphinxγια ολόκληρη την ανάλυση των χαρακτηριστικών του intersphinx.
Για να σας βοηθήσουμε να παίξετε με το intersphinx, θα θελήσετε να τα διεγείρετε μέσα στο conf.py βάζοντας τη νέα ακολουθία ‘sphinx.ext.intersphinx’ στη λίστα επεκτάσεων και να την τοποθετήσετε εντός της τιμής διαμόρφωσης intersphinx_mapping. Το Sphinx υποστηρίζει την ολοκαίνουργια προσθήκη εγγράφων από τα modules που έχουν επέκταση (μια επέκταση είναι στην πραγματικότητα μια εξαιρετική Pythonmodule που δίνει πρόσθετες δυνατότητες στα δικά του έργα Sphinx) που ονομάζεται autodoc. Το νεότερο αρχείο διατηρείται μέσα στο UTF-8 από προεπιλογή, επειδή η δήλωση κωδικοποίησης εκφράζεται στην πρώτη γραμμή. Κατανοήστε ότι το φρέσκο αρχείο χρησιμοποιεί δομή προτάσεων Python για να έχει αλυσίδα, ποσότητα, καταλόγους και ούτω καθεξής για το. Προσαρμόστε μια αξία διαμόρφωσης που δεν προστίθεται άμεσα bysphinx-quickstart, βάλτε μόνο μια συμπληρωματική ανάθεση. Τομείς για όλα τα διαθέσιμα ονόματα τομέα καθώς και τις οδηγίες/θέσεις τους.
Βασική διάταξη¶
Αυτά θα μπορούσαν να καταλήξουν να εκτελούνται εκτελώντας τη δημιουργία στην ετικέτα του δημιουργού σας. (Μπορεί να περιέχουν από μόνες τους οδηγίες toctree, πράγμα που σημαίνει ότι μπορείτε να κάνετε σοβαρά ένθετες ιεραρχίες εάν είναι απαραίτητο.) Και, η Sphinx τώρα γνωρίζει για την αγορά και τη σκάλα των δεδομένων σας. Πραγματικά έτσι φαίνεται το tocttree για αυτά τα έγγραφα. Κάθε οδηγία καθορίζει εάν πρέπει να αναρτηθεί και ποια κατεύθυνση πρέπει να ακολουθήσει.
Πακέτο Conda¶
Αυτό μπορεί να Spinfest σύνδεση Ελλάδα γίνει μέσω της αλήθειας pdf που λέγεται εκεί. Για να συνδυάσετε τις δύο συμβουλές με τη μοναδική, εξερευνήστε sphinx-build -M(i.elizabeth. -M latexpdf ίσως όχι -b latexpdf) διαφορετικά κάντε latexpdfat τους πόρους του έργου. Ποιος δημιουργός παρέχει την ίδια αποτελεσματικότητα ενώ ο αυτόνομος δημιουργός HTML, αλλά δημιουργεί επίσης ένα ενθουσιώδες αρχείο epub για συνδρομητές ebook. Ότι το πρόγραμμα δημιουργίας παρέχει την ίδια έξοδο επειδή ο αυτόνομος δημιουργός HTML, αλλά δημιουργεί επίσης έγγραφο υποστήριξης για προγραμματιστές GNOME που επιτρέπει στον νέο αναγνώστη προγραμματιστή GNOME να αποκτήσει πρόσβαση σε αυτά.
Το Toctree είναι στην πραγματικότητα μια εξαιρετική οδηγία ReStructuredText, ένα εξαιρετικά ευέλικτο κομμάτι σήμανσης. Η πρόθεση αυτού του εγγράφου είναι να σας αφήσει μια γρήγορη γεύση για το τι είναι στην πραγματικότητα η Σφίγγα και πώς μπορείτε να τη χρησιμοποιήσετε.
Ρύθμιση μακριά από πόρους¶
Σε αντίθεση με τα άλλα δεδομένα τουρσί που το αρχείο τουρσί απαιτεί τη δυνατότητα απόκτησης του νεότερου πακέτου sphinx για την απομάκρυνσή σας. Αυτό μπορεί να είναι πάντα ένα εξαιρετικό αρχείο τουρσί, ανεξάρτητο από το πρόγραμμα δημιουργίας και θα έχετε ένα αντίγραφο του δικού σας περιβάλλοντος που χρησιμοποιήθηκε όταν ξεκίνησε ο δημιουργός. Το όνομα του αρχείου προμήθειας στο _supply.
Εάν κάνετε τέτοια αρχεία ανιχνεύσιμα που έχουν locale_dirs για το λεξιλόγιό σας, το Sphinxw θα τα πάρει αυτόματα. Η Σφίγγα τα εξάγει ως αποτέλεσμα της επίκλησης μακριά από το σφίγξιμο -M gettext. Χαρτογραφούν αφελώς μηνύματα μέσα σε ένα μάθημα, ώστε να μπορείτε να μετατρέψετε μια συμβολοσειρά. Το Sphinx χρησιμοποιεί αυτούς τους τύπους επιχειρήσεων, ώστε να μπορείτε να μεταφράσετε ολόκληρα δεδομένα. Υποστηριζόμενο για να μπορείτε να παραδίδονται μεταφράσεις σε κείμενα που δημιουργούνται από τη Σφίγγα, όπως παμπ πλοήγησης, το Sphinx φέρνει στοιχεία που βοηθούν στην ολοκαίνουργια ερμηνεία των εγγράφων. Ένας κατάλογος που μπορεί να χρησιμοποιηθεί για την εμφάνιση των νέων εγγράφων.
Στοιχεία δημιουργού σειριοποίησης¶
Μπορείτε να χρησιμοποιήσετε τον δικό σας διακομιστή Διαδικτύου για να επεξεργαστείτε τα χαρτιά Sphinx HTML. Το απλό γεγονός είναι αυτή η εναλλακτική που παρέχει πολύ μεγαλύτερη αυτοδυναμία, συν πολύ μεγαλύτερη δυσκολία. Το Read the Docs είναι μια διαδικτυακή υπηρεσία αφιερωμένη στη φιλοξενία τεχνικής τεκμηρίωσης που εκτυπώνεται στο Sphinx, καθώς και στο MkDocs. Θα βρείτε μια εξαιρετική ιστοσελίδα ερμηνείας Sphinx για έγγραφα Sphinx (κύριο).