Simpan Dan Jelajahi Dokumentasi di ReadTheDocs

Ridwan Fajar 11 Februari 2015

Simpan Dan Jelajahi Dokumentasi di ReadTheDocs

Read the Docs merupakan sebuah layanan untuk hosting dokumentasi proyek perangkat lunak anda. Perangkat lunak yang didokumentasikan dapat berupa framework, library, system, tools, dan aplikasi lainnya. Selain menyediakan layanan untuk hosting dokumentasi, Read the Docs juga dapat digunakan oleh programmer dan siapapun pada umumnya untuk mencari dokumentasi dari perangkat lunak yang Anda butuhkan. Website ini di open source kan oleh pemiliknya dan tersedia di Github. Dokumentasi yang terdapat di Read the Docs dapat diimpor menggunakan Mercurial, Git, Suberversion, dan Bazaar.

Read the Docs mudah digunakan jika Anda sudah menggunakan Sphinx Documentation. Format yang dapat digunakan untuk membangun dokumentasi di Read the Docs antara lain reStructuredText dan Markdown. Jika Anda menggunakan reStructuredText Anda dapat menggunakan Sphinx Documentation, sedangkan jika Anda ingin menggunakan Markdown, Anda dapat menggunakan mkdocs. Kedua tools tersebut dapat diunduh melalui PIP.

Read the Docs juga dapat di integrasikan dengan Github dan Bitbucket, yang dapat membantu Anda agar dapat memperbaharui proyek Anda lebih cepat. Selain itu terdapat fitur Webhooks yang dapat digunakan untuk auto-updating. Selain fitur diatas, Read the Docs memiliki fitur alternate domains, full text search, pdf generation, dan canonical urls.

Anda dapat mengakses Read the Docs disini (https://about.readthedocs.com/?ref=readthedocs.com)