Getting Started

Usage

Cukup pip install sphinx-design dan tambahkan ekstensi ke conf.py Anda:

extensions = ["sphinx_design"]

Untuk penggunaan dengan MyST Parser, untuk dokumentasi Markdown, disarankan untuk menggunakan ekstensi sintaksis colon_fence:

extensions = ["myst_parser", "sphinx_design"]
myst_enable_extensions = ["colon_fence"]

Configuration

Untuk menyembunyikan judul tajuk suatu halaman, tambahkan di bagian atas halaman:

#MyST Markdown
---
sd_hide_title: true
---

#RestructuredText
:sd_hide_title:

Creating custom directives

Ditambahkan di versi 0.6.0.

Anda dapat menggunakan opsi konfigurasi sd_custom_directives di conf.py untuk menambahkan direktif khusus, dengan nilai opsi default:

sd_custom_directives = {
    "dropdown-syntax": {
        "inherit": "dropdown",
        "argument": "Syntax",
        "options": {
            "color": "primary",
            "icon": "code",
        },
    }
}

Kuncinya adalah nama direktif baru yang akan ditambahkan, dan nilainya adalah kamus dengan kunci-kunci berikut:

  • inherit: Direktif yang akan diwarisi (misalnya dropdown)

  • argument: Argumen default (opsional, hanya untuk direktif yang menerima satu argumen)

  • options: Kamus opsi default untuk direktif (opsional)

Supported browsers

  • Chrome >= 60

  • Firefox >= 60

  • Firefox ESR

  • iOS >= 12

  • Safari >= 12

  • Explorer >= 12

(Mirrors: https://github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc)

Migrasi dari sphinx-panels

Paket ini muncul sebagai iterasi dari sphinx-panels, dengan tujuan membuatnya lebih fleksibel, lebih mudah digunakan, dan meminimalkan konflik CSS dengan tema sphinx.

Perubahan penting:

Mengurangi penggunaan langsung kelas CSS

Kelas-kelas ini digantikan dengan penggunaan opsi direktif, yaitu:

  • Lebih mudah dipahami

  • Lebih mudah divalidasi

  • Lebih mudah bekerja dengan keluaran non-HTML

  • Lebih mudah ditingkatkan/difaktorkan ulang

panel directive replaced

Direktif panel digantikan dengan penggunaan direktif grid tingkat atas, kemudian menggunakan turunan direktif grid-item-card, alih-alih membatasi kartu dengan ---.

Jika tidak diperlukan kartu, direktif grid-item dapat digunakan sebagai gantinya dan kartu juga dapat digunakan secara independen dari grid.

Kira-kira, .. panels:: setara dengan .. grid:: 1 2 2 2 dengan opsi :gutter: 2.

tabbed directive replaced

Direktif tabbed digantikan dengan penggunaan direktif tab-set tingkat atas, kemudian menggunakan turunan direktif tab-item.

Opsi :sync: memungkinkan sinkronisasi pemilihan tab antar set.

Direktif tab-set-code menyediakan singkatan untuk contoh kode yang disinkronkan.

octicon icon role

SVG default yang dihasilkan kini berukuran relatif terhadap teks di sekitarnya (yaitu menggunakan 1em). Sintaks untuk menentukan ukuran khusus dan menambahkan kelas juga diubah.

Hal serupa berlaku untuk ikon favicon, di mana pemisah , juga diganti dengan ;, misalnya :fa:`name,class` -> :fa:`name;class`.

Improved CSS

CSS Bootstrap diperbarui dari v4 -> v5, yang khususnya memungkinkan grid tingkat atas untuk menentukan nomor kolom dan ukuran gutter.

Semua kelas CSS diawali dengan sd- (tidak bentrok dengan CSS tema/ekstensi lain).

Semua warna menggunakan variabel CSS (dapat disesuaikan).