sphinxcontrib-taglist

sphinxcontrib-taglist είναι μια Σφίγγα "taglist" επέκταση.
TagList
Taglist είναι μια επέκταση για Σφίγγα σύστημα τεκμηρίωσης.
installation
Εγκατάσταση μέσω PIP:
Pip εγκαταστήσετε sphinxcontrib-taglist
ή μέσω GitHub:
GIT κλώνος https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-taglist
python setup.py εγκαταστήσετε
Στη συνέχεια, θα πρέπει να προσθέσετε την επέκταση στο «conf.py» στο έργο σφίγγα σας.
επεκτάσεις = [
& Nbsp? ...,
& Nbsp? "Sphinxcontrib.taglist»,
& Nbsp? ...]
Διαμόρφωση
Όταν χρησιμοποιείτε ετικέτες με την επέκταση αυτή μπορεί να θέλετε να δώσει σε κάθε ετικέτα άλλο χρώμα. Μπορείτε να το κάνετε αυτό σε «conf.py», προσθέτοντας:
taglist_tags = {
& Nbsp? 'TAG1 ": {" background-color »:« πράσινες »}
}
Οδηγίες
ετικέτα:
& Nbsp? Οδηγία ετικέτα προσθέσετε ένα «κομμάτι» των πληροφοριών, και μπορείτε να το επισημάνετε.
& Nbsp? Μπορείτε να το χρησιμοποιήσετε σαν:
& Nbsp? .. Ετικέτα :: Μερικές Tagged πληροφορίες
& Nbsp?: Ετικέτα: TAG1 TaG2 TAG3
& Nbsp? Ή:
& Nbsp? .. Ετικέτα :: [TAG1 TaG2 TAG3] Μερικές Tagged πληροφορίες

& Nbsp? Προειδοποίηση: Η δεύτερη μέθοδος χρησιμοποιείται μόνο εάν η πρώτη μέθοδος δεν είναι.
& nbsp? Προειδοποίηση: Δεν είμαι σίγουρος ότι αυτό σύνταξη, αυτό μπορεί να αλλάξει. Αν έχετε προτάσεις Anny παρακαλώ επιτρέψτε μου να ξέρω.
taglist:
& Nbsp? Taglist είναι μια οδηγία, τα οποία συλλαμβάνουν τις ετικέτες και να κάνει μια λίστα.
& Nbsp? Πρώτον εκτυπώνει »Ετικέτες: ...« με τις πληροφορίες που εμφανίζει ετικέτες, και από ό, τι δείχνει τη λίστα.
& Nbsp? Μπορείτε να το χρησιμοποιήσετε σαν:
& Nbsp? .. Taglist ::
& Nbsp?: Ετικέτες: TAG1 TAG3
Πως δουλεύει?
Η βάση κώδικα προέρχεται από sphinxcontrib-απαιτήσεις ώστε να λειτουργεί με παρόμοιο τρόπο.
Κατά τη διάρκεια της έγγραφο οδηγιών ετικέτα ανάγνωση δημιουργούν tag_node`s. `Taglist δημιουργούν taglist κόμβους.
Κατά την επίλυση taglist κόμβοι αλλάζουν σε ένα κομμάτι του κειμένου Tags: με ετικέτες αντικειμένων που θα εμφανιστούν στον εν λόγω κατάλογο. Στη συνέχεια τυπώνει όλες τις ετικέτες προϊόντων.
CSS
taglist.css:
& Nbsp? Περιέχει βάση την κατηγορία για την ετικέτα - taglist_tag

& Nbsp? Προειδοποίηση: Κατά πάσα πιθανότητα θα πρέπει να αλλάξει και να θέσει σε taglist_tags.css. (Και θα είναι παραμετροποιήσιμο από conf.py)
Επιπλέον, δημιουργεί την taglist_tags.css αρχείο κατά τη διάρκεια της επεξεργασίας (με CSS για κάθε ετικέτα που ορίζεται στο conf.py? Taglist_tags χάρτες όλα τα κλειδιά ετικέτα με τα πλήκτρα CSS). Και να το γράψετε για να χτίσει τον κατάλογο με στατικά αρχεία

Απαιτήσεις :

• Python
• Σφίγγα