Memulai

Pendahuluan

Jika belum pernah atau memiliki Python virtual environment, sebaiknya dibuat VENV dengan nama .venv atau lainnya. dilanjutkan dengan mengaktifkan .venv dan melakukan instalasi Sphinx dengan menjalankan perintah:

$ python -m venv .venv
$ source .venv/bin/activate
(.venv) $ phyton -m pip install sphinx

Periksa hasil intalasi dengan perintah:

(.venv) $ sphinx-build --version
sphinx-build 8.2.3

Membuat layout dokumen

Jalankan perintah berikut:

(.venv) $ sphinx-quickstart docs

Ini akan menyajikan serangkaian pertanyaan yang diperlukan untuk membuat direktori dasar dan tata letak konfigurasi untuk proyek Anda di dalam folder docs. Untuk melanjutkan, jawab setiap pertanyaan sebagai berikut:

• > Separate source and build directories (y/n) [n]: Write “y” (without quotes) and press Enter.

• > Project name: Write “Lumache” (without quotes) and press Enter.

• > Author name(s): Write “Graziella” (without quotes) and press Enter.

• > Project release []: Write “0.1” (without quotes) and press Enter.

• > Project language [en]: Leave it empty (the default, English) and press Enter.

Akan melihat direktori dokumen baru dengan konten berikut.

docs
├── build
├── make.bat
├── Makefile
└── source
   ├── conf.py
   ├── index.rst
   ├── _static
   └── _templates

Berkat langkah bootstrapping ini, Anda sudah memiliki semua yang dibutuhkan untuk merender dokumentasi sebagai HTML untuk pertama kalinya. Untuk melakukannya, jalankan perintah ini pada directory docs:

(.venv) $ make html