Τα επιχειρήματα παρέχονται προσωπικά μετά την άνω τελεία μετά τη λήξη της οδηγίας. Το Toctree είναι μια εξαιρετική οδηγία για το αναδομημένο κείμενο, ένα πολύ ευέλικτο κομμάτι σήμανσης. Δημιούργησαν έναν καλό κατάλογο προέλευσης με το conf.py και ίσως ένα αρχείο root, directory.rst.
Τυπικές επιλογές οδηγίας¶
Ένα καλό λεξικό για να έχει τα προφίλ που περιγράφουν τη μορφή ψευδωνύμων, καταγράφει έναν όρο εφαρμογής για να δώσει το πλήρες αναγνωρισμένο όνομα αντικειμένου. Αξίζει λοιπόν να ρυθμίσετε απλές συμβουλές για την εμφάνιση γραφομηχανών. Αυτό είναι χρήσιμο όταν κάποιες πρόσθετες εξαρτήσεις δεν συναντώνται κατά τη δημιουργία κάποιας στιγμής διακοπής της νέας διαδικασίας κατασκευής.
Πού μπορείτε να τοποθετήσετε τις μεμονωμένες επεκτάσεις σας;¶
Από πολλά έγγραφα Sphinx, www.abuking777.com/el/app όπως τα αρχεία Python, δημοσιεύονται στους ιστότοπους. Διαμόρφωση για χαρτιά όλων των διαθέσιμων τιμών διαμόρφωσης. Το νέο αρχείο προσπάθησε να προστατεύεται στο UTF-8 αυτόματα, αφού φαίνεται από τη δήλωση κωδικοποίησης στην πρώτη περιοχή. Προσαρμόστε μια εξαιρετική ρύθμιση παραμέτρων που δεν είναι αυτόματα επιπλέον γρήγορη εκκίνηση, αλλά απλώς βάλτε μια πρόσθετη ανάθεση. Πριν είπα ότι το νέο έγγραφο conf.py ελέγχει ακριβώς τον τρόπο με τον οποίο επεξεργάζεται το Sphinx τα έγγραφά σας. Τομείς για όλα τα διαθέσιμα ονόματα τομέα καθώς και τις οδηγίες/θέσεις τους.
Εμφανίστε το νεότερο εμπορικό σήμα στην ετικέτα της τάξης σας. Σε περίπτωση που η κατηγορία σας δεν έχει τη μέθοδο __init__ ή εάν η συμβολοσειρά εγγράφων της ολοκαίνουργιας μεθόδου __init__ είναι κενή, ωστόσο η ταξινόμηση έχει τη συμβολοσειρά εγγράφων της μεθόδου __new__, χρησιμοποιείται αντ’ αυτού. Τόσο η ταξινόμηση» όσο και η συμβολοσειρά της μεθόδου __init__ στην πραγματικότητα συνενώνονται και εισάγονται. Εισάγεται μόνο η συμβολοσειρά εγγράφων της ομάδας. Αξίζει πραγματικά να επιλέξετε ακριβώς το περιεχόμενο που εισήχθη στο κύριο σύστημα της οδηγίας για την ανατοκλάση. Η νέα εκτέλεση που δημιουργήθηκε από την ομάδα ιστορικού δεν θα υποστηρίζει τη μορφή ψευδωνύμων PEP 695.
Κυκλοφορεί όταν το autodoc χρειάζεται να επιλέξει εάν ένα εξάρτημα μπορεί να χρησιμοποιηθεί ή όχι στην τεκμηρίωση. Εάν το Real, το ολοκαίνουργιο πρότυπο αμφισβητεί τη σκέψη από τις συναρτήσεις δεν θα αναλυόταν δημιουργώντας αρχείο. Ωστόσο, όχι, είναι ένα κανονικό σεμινάριο για να φέρετε τη νέα υπογραφή στην πρώτη γραμμή των εγγράφων της λειτουργίας σας. Αυτός ή αυτή τίθεται σε όλες τις autodocdirectives αμέσως. Έτσι, η αξία επιλέγει τον τρόπο με τον οποίο το εμπορικό σήμα εκτέθηκε στην ομάδα που ορίζεται από την οδηγία autoclass.
Ανακύκλωση υπογραφών και μπορείτε να εγγράφετε με το autodoc¶
Μπορείτε ακόμα να αρχειοθετήσετε __init__ από την άλλη στρατηγική χρησιμοποιώντας την αυτόματη μέθοδο ή ακόμα και την επιλογή των επαγγελματιών για αυτόματη ταξινόμηση. Για αυτόν τον λόγο, μπορείτε να συνδυάσετε αυτόματα και αρχεία μελών χαμηλής αυτοματοποίησης. Από προεπιλογή, το autodoc προσπαθεί να αποκτήσει τη μορφή σχολιασμού και την τιμή του νέου ρυθμιζόμενου με την ενδοσκόπηση, εμφανίζοντάς το ακολουθώντας την ετικέτα του προσαρμοζόμενου. Για να το παρακάμψετε, μια προσαρμοσμένη ακολουθία της τιμής της μεταβλητής σας μπορεί να ληφθεί ως όρισμα, ώστε να μπορείτε να κάνετε σχολιασμό. Μην δημιουργείτε μια εισαγωγή καταλόγου στην αναφορά σας ποικίλλει ή συνεχίζεται. Κάνοντας όλες τις επιλογές που συζητούνται κάτω από την προεπιλογή, χρησιμοποιήστε το λεξικό autodoc_default_alternatives στο conf.py. Άλλες διάλεκτοι προσπαθούν να έχουν εγγενή προσφορά στη Σφίγγα να διαθέτουν οδηγό κωδικοποιητική τεκμηρίωση, ωστόσο θέλουν επεκτάσεις για την κατοχή της αυτοματοποιημένης κωδικοποίησης, συμπεριλαμβανομένης της εισπνοής.
Ρύθμιση¶
Αυτό μπορεί να συμπεριληφθεί στο autodoc core μακροπρόθεσμα. Κάτι που αξίζει να ρυθμίσετε τη νέα μορφή των γραφομηχανών. Τα ψευδώνυμα ταξινόμησης είναι απλώς διαθέσιμα εάν το σύστημα επιτρέπει τη λειτουργία Αναβολής Αξιολόγησης μακριά από Σχολιασμούς (PEP 563) μέσω σημαντικών σημειώσεων __future__.
πακέτο Conda¶
Ότι η επέκτασή του μπορεί επίσης να μεταφέρει τις νέες μονάδες που εγγράφετε, και μπορείτε να κάνετε εγγραφές μακριά από συμβολοσειρές εγγράφων μέσα σε ένα εξαιρετικό ημιαυτόματο μέσο. Σε ποιο sourcedir είναι η λίστα προμηθειών και μπορείτε να εξάγετε τον κατάλογο το μέρος που χρειάζεστε για να τοποθετήσετε τα αρχεία που έχουν δημιουργηθεί. Η νέα εναλλακτική λύση -Yards επιλέγει έναν οικοδόμο. μέσα στο exampleSphinx συνήθως δημιουργούνται αρχεία HTML. Υπάρχουν ακόμη και πολλά έχουν επιπλέον από το Sphinx. Συμπεριλαμβανομένου, μπορείτε να αναμίξετε εγγραφές στο φορητό μέσο (και αυτό λειτουργεί για τις μάρκες αποδοτικότητας) με τον ρόλο αναφοράς. Ότι χωρίζεται και υποστηρίζει προσαρμοσμένο κείμενο σύνδεσης στη γενική σύνταξη μεταξύ ιστοτόπων.