Introduction

Instalasi Sphinx

Langkah pertama untuk memulai adalah menginstal Sphinx. Sphinx adalah proyek Python, jadi dapat diinstal seperti pustaka Python lainnya. Beberapa Sistem Operasi (Mac OS X, Versi Utama Linux/BSD) telah menginstal Python sebelumnya, jadi Anda hanya perlu menjalankan:

$ brew install sphinx-doc

Memulai

Anda sebaiknya membaca panduan Memulai Sphinx, karena panduan ini menyediakan pengantar untuk banyak ide dasar. Jika Anda menggunakan alat sphinx-quickstart yang dijelaskan di sana, alat ini akan membuat contoh proyek dengan struktur standar berikut:

project/
    docs/
        conf.py
        index.rst
        Makefile

index.rst

Fungsi utama dari file index.rst adalah root document yang berfungsi sebagai halaman selamat datang, dan untuk memuat “daftar isi” (table of contents tree atau toctree). Ini adalah salah satu hal utama yang Sphinx tambahkan ke reStructuredText, sebuah cara untuk menghubungkan beberapa file ke hierarki dokumen tunggal.

Direktif toctree awalnya kosong, dan tampak seperti ini:

.. toctree::
   :maxdepth: 2

Untuk menambahkan daftar dokumen ditambahkan konten directive:

.. toctree::
   :maxdepth: 2

   usage/installation
   usage/quickstart
   ...