Install & Create Project Sphinx Documentation

Posted on Updated on

Sphinx Documentation

Definisi

Sphinx adalah tools yang memungkinkan developer untuk menulis dokumentasi dalam bentuk plain text dan dapat menghasilkan output dalam format yang memenuhi berbagai kebutuhan (output: html, doc, rtf). Plain text merupakan salah satu format yang paling portable saat ini.

Beberapa fitur Sphinx:
  • Output formats: HTML (termasuk Windows HTML Help), LaTeX (untuk versi PDF), manual pages, plain text
  • Extensive cross-references: semantik markup dan link otomatis untuk function, class, citations, glossary terms dan potongan informasi
  • Hierarchical structure: definisi yang mudah untuk document tree, dengan link otomatis untuk siblings, parents and children
  • Automatic indices: general index serta module index
  • Code Handling: highlight otomatis menggunakan highlighter Pygments
  • Extensions: pengujian otomatis potongan kode, masuknya docstrings dari modul Python (API docs), dan lainnya
Untuk mendownload SPhinx dapat mengunjungi http://sphinx-doc.org/ . Sebelum menggunakan Sphinx ini, komputer kita terlebih dahulu harus diinstal Python (Bahasa Pemrograman). Karena Sphinx ini berbasiskan Bahasa Pemrograman Python

Install

Untuk menginstall sphinx dapat menggunakan dua cara yaitu dengan menginstal dengan virtual environment atau melalui source package Sphinx.

Install dengan virtual environment. Ketikkan di command prompt :

pip install sphinx

Untuk install source package, source sphinx bisa didapat di http://pypi.python.org/pypi/Sphinx. Setelah itu masuk ke dalam folder tersebut, kemudian di command prompt ketikkan :
python setup.py install

Create Project Sphinx

Untuk membuat project di Sphinx, di cmd ketikkan code :

$ sphinx-quickstart

Lalu di cmd akan muncul pesan :

Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets).

Untuk mengisi daftar pertanyaan yang ditampilkan saat quick-startproject default adalah sebagai berikut :

Prompt Choice
> Root path for the documentation[.]: ENTER
>Separate source and build directories(y/N) [n]: y
> Name prefix for tempaltes and static dir [_]: ENTER
> Project name : an_example_pypi_project
> Author name(s): Andrew Charter
> Project version: 0.0.1
> Project release[0.0.1] ENTER
> Source file suffix[.rst]: ENTER
> Name of your master document (without suffix) [index]: ENTER
> autodoc: automatically insert docstring from modules (y/N) [n] y
> doctest: automatically test code snippets in doctest blocks (y/N) [n]: n
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]: y
> todo: write “todo” entries that can be shown or hidden on build (y/N) [n]: n
> coverage: checks for documentation coverage (y/N) [n]: n
> pngmath: include math, rendered as PNG images (y/N) [n]: n
> jsmath: include math, rendered as PNG images (y/N) [n]: n
> Create Makefile? (Y/n)[y]: y
> ifconfig: conditional inclusionof content based on config values (y/N) [n]: n

Running the build

Jika menambahkan file atau mengubah data, maka project harus dibuild, dengan cara

$ sphinx-build -b html sourcedir builddir
Jika saat user membuat project, menghasilkan MakeFile dan make.bat maka untuk running project dapat dilakukan dengan code berikut

$ make html

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s