Berbagi teknologi

Beberapa tip untuk Markdown Sphinx Read_the_Docs

2024-07-11

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

Markdown Sphinx Read_the_Docs dapat digunakan untuk membuat beranda pribadi atau tutorial pengetahuan. Ada banyak metode pembuatan di Internet Anda dapat merujuk ke pakar iniartikel . Artikel ini terutama membahas tentang beberapa teknik yang dapat membuat proyek lebih sempurna.

Lingkungan saya yang berjalan adalah WSL2 Ubuntu 22.04, dan versi Sphinx adalah 7.3.7


Konstruksi satu proyek

Setelah Sphinx terinstal, jalankan di terminalsphinx-quickstart, maka akan muncul opsi: Apakah Anda perlu memisahkan direktori sumber dan direktori build?
Masukkan deskripsi gambar di sini
Pilih ya di sini, masukkan y dan tekan Enter. Keuntungan pemisahan adalah struktur proyek lebih jelas.

Isi saja dengan santai. Yang terakhir adalah bahasa proyek. Di sini, pilih Bahasa Mandarin Sederhana.zh_CN
Masukkan deskripsi gambar di sini
Pada titik ini, proyek telah selesai.


2. Instal pluginnya

1. Plug-in dukungan penurunan harga—MyST-Parser

Sphinx mendukung reStructuredText secara default, tetapi kebanyakan orang menggunakan Markdown untuk menulis artikel, jadi Anda perlu menginstal plug-in MyST-Parser yang mendukung Markdownhttps://myst-parser.readthedocs.io/id/terbaru/, perintah instalasinya adalah sebagai berikut,

pip install -U myst-parser