Τείνουν να είναι έγγραφα εγγράφων

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

• Το Sphinxdoc/sphinx-latexpdf αποτελείται από πακέτα TeXLive.
• Αποφύγετε τη χρήση __all__ κατά την εξέταση της νεότερης ενότητας που θα αρχειοθετήσετε.
• Ποια τιμή ελέγχει την κληρονομικότητα των ολοκαίνουργιων συμβολοσειρών εγγράφων. Εάν το σύνολο σε Γνήσιο, η νέα συμβολοσειρά εγγράφων για κατοχή ομάδων, διαφορετικά, συμβουλές, εάν δεν έχει οριστεί ρητά, στην πραγματικότητα παραδίδεται από τους γονείς.
• Αποστέλλεται μόνο όταν παρέχεται η ολοκαίνουργια επιλογή κληρονομιάς.

Ρύθμιση¶

Παράγεται κάθε φορά που το autodoc έχει διαβάσει και επεξεργάζεται μια https://gr.brucebet.org/app συμβολοσειρά εγγράφων. Αξίζει να ρυθμίσετε την κληρονομιά των νεότερων συμβολοσειρών εγγράφων. Εάν ορίσετε σε True το ολοκαίνουργιο docstring για να έχετε ομάδες ή διαδικασίες, εάν δεν το τοποθετήσετε σαφώς, δοκιμάστε να μεταβιβαστεί από τους γονείς. Είναι εξοικειωμένος με τον τύπο συνέχισης των ψευδωνύμων που δεν αναλύονται στο αρχείο. Οι πλημμυρισμένες συναρτήσεις διαφορετικά οι ενέργειες δεν θα περιλαμβάνουν πινακίδες πληκτρολόγησης στην περιγραφή, καθώς δεν είναι πρακτικό να απεικονίζονται με ακρίβεια όλες οι πιθανές υπερφορτώσεις ενώ το μεγάλο σύνολο παραμέτρων.

Docker¶

Η ριζική λίστα μιας εξαιρετικής προμήθειας αρχείων απλού κειμένου διακριτού Sphinx ονομάζεται λίστα αιτιών. Μόλις φτάσετε κι εσείς εδώ, μπορείτε να ταξιδέψετε στο βιβλίο εγκατάστασης συνοδευόμενο από την ολοκαίνουργια εισαγωγή, ώστε να μπορείτε να κάνετε την προεπιλεγμένη δομή σήμανσης που χρησιμοποιείται από το Sphinx, ReStructuredText. Ο στόχος του so it file θα ήταν να σας αφήσει μια στιγμιαία γεύση από το τι ακριβώς είναι το Sphinx και πώς μπορείτε να το χρησιμοποιήσετε.

• Μπορείτε να βρείτε πολλές επεκτάσεις που συνεισφέρθηκαν από τα προφίλ σχετικά με τον οργανισμό sphinx-contriborganization.
• Δημιουργήστε αυτόματα έγγραφα για να κατέχετε ειδικά άτομα στην ομάδα στόχων, τα οποία έχουν χαρακτηριστεί ως επωνυμίες “dunder”. Για παράδειγμα, όλες οι επωνυμίες κλείνουν με διπλή υπογράμμιση, π.χ.
• Και παράγει μια εξαιρετική σύνδεση με τη νέα αντίστοιχη οδηγία envvar, εάν μπορεί να αποκτηθεί.

Διασταύρωση πραγμάτων¶

Το νεότερο δεδομένο όνομα αρχείου μπορεί να είναι σε σχέση με το νέο ευρετήριο στο οποίο περιέχεται το τρέχον αρχείο προέλευσης, ωστόσο, εάν είναι φυσικό (αρχίζοντας με /), λαμβάνεται σύμφωνα με τη λίστα κύριας προέλευσης. Σχέση με το επιθυμητό αρχείο. το νεότερο όνομα αρχείου πιθανότατα θα είναι μια σχετική, διαφορετικά απόλυτη διαδρομή και συνήθως γίνεται διάκριση πεζών-κεφαλαίων, ακόμη και για το Παράθυρο. Αποστέλλεται μόνο όταν δίνεται η επιλογή νέας ενημέρωσης-γενετική. Το Basics είναι στην πραγματικότητα μια λίστα κλάσεων που απολαμβάνουν τη ρύθμιση του handler canmodify για να αλλάξει αυτό που ορίζει το Sphinx στην έξοδο. Όταν η μηδενική γραμμή αντιστοιχίζεται, η ολοκαίνουργια συμβολοσειρά εγγράφων που προκύπτει ενδέχεται να είναι κενή, επομένως δεν θα γίνει καμία αλλαγή εκτός εάν ισχύει η διατήρηση κενή.

Ένας τομέας δοκιμάστε μερικούς τύπους αντικειμένων που ανήκουν μαζί της, που περιλαμβάνει σήμανση για δημιουργία και θα παραπέμπετε σε περιγραφές αυτών των πραγμάτων. Ένας από τους κύριους στόχους του Sphinx είναι τα εύκολα αρχεία από αντικείμενα (μέσα σε μια τυπική αίσθηση) σε σχεδόν οποιοδήποτε όνομα ιστότοπου. Αν και όχι, το λογισμικό sphinx-quickstart παράγει ένα εξαιρετικό Makefile και θα το amake.bat που θα κάνουν την ύπαρξη ακόμα πιο εύκολη για εσάς προσωπικά.

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

Αποφύγετε τη χρήση __all__ κάθε φορά που αναλύετε τη νέα ενότητα για τεκμηρίωση. Αντίθετα, το autodoc είναι επίσης αναγνώριση ενός εγγράφου στη νέα γραμμή μετά τον ορισμό. Εάν χρειάζεστε NumPy, διαφορετικά θα έχετε περισσότερες συμβολοσειρές εγγράφων σε στυλ Bing, μπορείτε επίσης να ενεργοποιήσετε το napoleon expansion. Το napoleon είναι ένας καλός προεπεξεργαστής για να μετατρέψει τις συμβολοσειρές εγγράφων για να διορθώσει το reStructuredText πριν από τη διαδικασία autodoc. Θα δημιουργήσετε μια φανταστική συλλογή λογισμικού που θα δημιουργήσει ένα τυχαίο μοτίβο φαγητού που θα σας βοηθήσει αφού είναι ένας εξαιρετικός οδηγός σε όλη τη διαδικασία, με σκοπό την ασφαλή τεκμηρίωσή του. Συνήθως το πακέτο ονομάζεται python3-sphinx, python-sphinx ή sphinx. Ανατρέξτε στη σελίδα thesphinx-create boy για να μάθετε περισσότερα.