Κοινή χρήση τεχνολογίας

Μερικές συμβουλές για το Markdown Sphinx Read_the_Docs

2024-07-11

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Το Markdown Sphinx Read_the_Docs μπορεί να χρησιμοποιηθεί για τη δημιουργία μιας προσωπικής αρχικής σελίδας ή ενός οδηγού γνώσης. Μπορείτε να ανατρέξετε σε αυτόν τον ειδικόάρθρο . Αυτό το άρθρο μιλά κυρίως για ορισμένες τεχνικές που μπορούν να κάνουν το έργο πιο τέλειο.

Το περιβάλλον λειτουργίας μου είναι το WSL2 Ubuntu 22.04 και η έκδοση Sphinx είναι 7.3.7


Κατασκευή ενός έργου

Αφού εγκατασταθεί το Sphinx, εκτελέστε το στο τερματικόsphinx-quickstart, τότε θα εμφανιστεί μια επιλογή: Χρειάζεται να διαχωρίσετε τον κατάλογο προέλευσης και τον κατάλογο κατασκευής;
Εισαγάγετε την περιγραφή της εικόνας εδώ
Επιλέξτε ναι εδώ, πληκτρολογήστε y και πατήστε Enter. Το πλεονέκτημα του διαχωρισμού είναι ότι η δομή του έργου είναι πιο ξεκάθαρη.

Απλώς συμπληρώστε το τυχαία Το τελευταίο είναι η γλώσσα του έργου.zh_CN
Εισαγάγετε την περιγραφή της εικόνας εδώ
Στο σημείο αυτό ολοκληρώνεται το έργο.


2. Εγκαταστήστε το plug-in

1. Πρόσθετο υποστήριξης Markdown—MyST-Parser

Το Sphinx υποστηρίζει το reStructuredText από προεπιλογή, αλλά οι περισσότεροι άνθρωποι χρησιμοποιούν το Markdown για να γράφουν άρθρα, επομένως πρέπει να εγκαταστήσετε το πρόσθετο MyST-Parser που υποστηρίζει το Markdownhttps://myst-parser.readthedocs.io/en/latest/, η εντολή εγκατάστασης είναι η εξής,

pip install -U myst-parser