Blogs
Για παράδειγμα, για να τεκμηριώσετε τη ρύθμιση enumerate() της Python, θα την προσθέσετε σε ένα από τα αρχεία δεδομένων πηγής σας. Τώρα που έχετε προσθέσει συγκεκριμένα αρχεία και θα έχετε άρθρα, ας δημιουργήσουμε μια κύρια δημιουργία μακριά από τα έγγραφα. Τα έγγραφα που πρέπει να συμπεριληφθούν δίνονται επειδή η επωνυμία του αρχείου, αυτό σημαίνει ότι αποσυνδέεστε από την επέκταση του ονόματος του εγγράφου και χρησιμοποιείτε κάθετες (/) προς τα εμπρός από τα διαχωριστικά καταλόγου. Αυτό είναι πραγματικά ένα από τα σημεία που το Sphinx αυξάνει το reStructuredText, μια μέθοδο για τη σύνδεση πολλών αρχείων σε τουλάχιστον μία ιεραρχία από αρχεία δεδομένων. Δημιούργησαν έναν κατάλογο προέλευσης με conf.py και ένα ριζικό έγγραφο, list.rst.
οικοδόμοι¶
Το πιο χρησιμοποιούμενο εργαλείο για την εγκατάσταση πακέτων μακριά από το PyPI είναι το pip, το οποίο περιλαμβάνεται σε όλα τα σύγχρονα μοντέλα της Python. Αυτό θα εκτυπώσει τον νεότερο αριθμό παραλλαγών της Σφίγγας. Αν και όχι, το conf.py μπορεί να βρίσκεται σε άλλο ευρετήριο, την πιο πρόσφατη λίστα ρυθμίσεων. Sphinx.ext.intersphinxγια ολόκληρη τη δυσλειτουργία των δικών σας χαρακτηριστικών της μεσσφίγγας.
Για να μπορείτε να παίξετε με το intersphinx, θα πρέπει να το διεγείρετε μέσα στο conf.py βάζοντας τη νέα ακολουθία ‘sphinx.ext.intersphinx’ στη λίστα επεκτάσεων και να το βάλετε μέσα στη διαμόρφωση intersphinx_mapping που αξίζει. Το Sphinx βοηθά στη νέα συμπερίληψη εγγράφων από τις μονάδες σας που έχουν μια Λήψη εφαρμογής σύνδεσης Trinocasino επέκταση (μια επέκταση είναι μια μονάδα Python που δίνει νέες δυνατότητες στα δικά σας έργα Sphinx) που ονομάζεται autodoc. Το νέο αρχείο προστατεύεται αυτόματα μέσα στο UTF-8, αφού υποδεικνύεται από τη δήλωση κωδικοποίησης στην 1η περιοχή. Λάβετε υπόψη ότι το νέο έγγραφο χρησιμοποιεί σύνταξη Python για να διαθέτει αλυσίδα, αριθμούς, καταλόγους και ούτω καθεξής για το. Προσαρμόστε μια ρύθμιση παραμέτρων που αξίζει πραγματικά, η οποία δεν αξίζει άμεσα επιπλέον bysphinx-quickstart, απλώς συμπεριλάβετε μια συμπληρωματική εργασία. Τομείς για όλα τα διαθέσιμα ονόματα τομέα και τις οδηγίες/θέσεις εργασίας τους.
Βασική ρύθμιση¶
Αυτά θα μπορούσαν να πραγματοποιηθούν τρέχοντας τη δημιουργία με τη θητεία του κατασκευαστή κάποιου. (Θα μπορούσαν να περιέχουν από μόνες τους οδηγίες toctree, πράγμα που σημαίνει ότι μπορείτε να κάνετε βαθειά ένθετες ιεραρχίες εάν είναι απαραίτητο.) Και, η Sphinx σήμερα κατανοεί την αγορά και μπορείτε να κάνετε βήματα των αρχείων δεδομένων σας. Έτσι εμφανίζεται το toctree for it records. Κάθε οδηγία αποφασίζει εάν θα επιτρέψει ή όχι να είναι αναρτήσεις και μπορείτε να κάνετε τι να κάνετε σε αυτήν.
σχέδιο Conda¶
Μπορείτε να το κάνετε αυτό για να ειπωθεί όλη η αλήθεια pdf εκεί. Για να συνδυάσετε και τα δύο βήματα στο μοναδικό, διασκεδάστε με το Sphinx-make -M(we.elizabeth. -Yards latexpdf ίσως όχι -b latexpdf) ή δημιουργήστε latexpdf στο root των πάνελ σας. Ότι ο δημιουργός του παράγει την ίδια αποτελεσματικότητα από τον αυτόνομο δημιουργό HTML, αλλά παράγει επίσης έντονους συνδρομητές ηλεκτρονικών βιβλίων που δηλώνουν το epub. Έτσι, το πρόγραμμα δημιουργίας παρέχει παρόμοια έξοδο από τον αυτόνομο δημιουργό HTML, αλλά παράγει επίσης ένα αρχείο υποστήριξης προγραμματιστών GNOME το οποίο επιτρέπει στον πιο πρόσφατο πρόγραμμα προβολής GNOME Devhelp να αποκτήσει πρόσβαση σε αυτόν.
Toctree δοκιμάστε μια εξαιρετική οδηγία για το reStructuredText, ένα απίστευτα ευέλικτο κομμάτι σήμανσης. Ο στόχος του εγγράφου του So it είναι να σας δώσει μια άμεση γεύση από το τι είναι οι Sphinx και πώς μπορείτε να τις χρησιμοποιήσετε.
Εγκατάσταση από την πηγή¶
Σε αντίθεση με τα άλλα αρχεία τουρσί, το έγγραφο τουρσί απαιτεί ότι το φρέσκο πακέτο σφίγγας μπορεί να αποκτηθεί στο ξεπάσωμα. Αυτό είναι συνήθως ένα έγγραφο τουρσί, ανεξάρτητο μακριά από τον κατασκευαστή και μπορείτε να κάνετε ένα αντίγραφο του οικοσυστήματος κάποιου που χρησιμοποιήθηκε όταν ξεκίνησε ο δημιουργός. Τίτλος του εγγράφου καταγωγής κάποιου μικρότερος από _προσφορά.
Αν κάποιος κάνει τέτοια αρχεία με δυνατότητα εντοπισμού που έχουν locale_dirs για τη γλώσσα, το Sphinxw θα τα πάρει αμέσως. Η Σφίγγα τα εξάγει χάρη στην επίκληση από την κατασκευή σφίγγας -M gettext. Καταγράφει αφελώς μηνύματα εντός του μαθήματος, ώστε να μπορείτε να μετατρέψετε μια συμβολοσειρά. Το Sphinx χρησιμοποιεί αυτούς τους τύπους οργάνωσης για να μετατρέψει ολόκληρα δεδομένα. Συμπληρωματικά για να σας βοηθήσει μεταφράσεις σε κείμενα που έχουν δημιουργηθεί από τη Σφίγγα, συμπεριλαμβανομένων των ράβδων πλοήγησης, το Sphinx θα προσφέρει συστήματα που διευκολύνουν τη νέα μετάφραση εγγράφων. Μια λίστα που χρησιμοποιήθηκε για την ιδιοκτησία των ολοκαίνουργιων εγγράφων.
Λεπτομέρειες δημιουργίας σειριοποίησης¶
Μπορείτε να χρησιμοποιήσετε το δικό σας ηλεκτρονικό μηχάνημα σε διακομιστές έγγραφα HTML Sphinx. Θα είναι η επιλογή που θα σας παρέχει μεγαλύτερη ανεξαρτησία, αλλά και μεγαλύτερη δυσκολία. Δείτε τα Έγγραφα είναι μια διαδικτυακή λύση που ειδικεύεται στη φιλοξενία τεχνικής τεκμηρίωσης που εκτυπώνεται στο Sphinx, καθώς και στο MkDocs. Θα βρείτε μια καλή ιστοσελίδα μετάφρασης Sphinx για να κατέχετε αρχεία Sphinx (κύριοι).
