Sphinx adalah alat berbasis Python yang berguna untuk teknisi dan penulis yang memungkinkan mereka untuk dengan mudah membuat dokumentasi yang elegan dan berfungsi penuh dalam berbagai format. Dengan Sphinx, Anda menulis dokumen menggunakan reStructuredText - bahasa markup ringan - sebagai permulaan, maka Anda bisa mendapatkan output dalam berbagai format, termasuk HTML, LaTeX, PDF, ePub, dan lainnya.
Dalam tutorial ini, kita akan membahas proses menginstal dan menggunakan Sphinxinstance CentOS 7 x64 pada platform Vult.
sudo yum update
sudo shutdown -r now
sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx
Sebelum mulai menggunakan Sphinx, Anda perlu menentukan direktori sumber Anda yang Sphinxakan menjalankan dan menyimpan semua dokumentasi Anda. Setelah Anda membuat direktori yang ingin Anda gunakan, Anda kemudian dapat menjalankan sphinx-quickstartyang akan menginisialisasi Sphinxdan membuat konfigurasi dasar yang diperlukan.
sphinx-quickstart mirip dengan wizard pengaturan yang akan meminta Anda dengan pertanyaan yang menentukan aspek proyek Anda.
cd ~
mkdir doc1
cd doc1
sphinx-quickstart
Secara default, sphinx-quickstartwizard akan membuat beberapa direktori dan file.
_build # The directory for containing Sphinx output
conf.py # The file containing your project configurations
index.rst # The master file containing the hierarchy of your documentation
make.bat # A Windows command file
Makefile # A file necessary for running the make command
_static # The directory for static files, including custom stylesheets, pictures, etc.
_templates # The directory for custom templates
Mari kita lihat file master index.rst,, yang berisi hierarki dokumentasi Anda; yaitu, daftar isi pohon atau toctree.
Buka dengan editor teks:
vi index.rst
Saat Anda meninjau file, Anda akan melihat bagian yang disebut toctree. Jika Anda memiliki file sumber lain ( *.rst) untuk dokumentasi Anda, Anda harus menentukannya di toctreebagian: .. toctree ::: maxdepth: 2
introduction
chapter1
chapter2
chapter3
more
Sangat penting untuk:
.rst.:maxdepth: 2.Setelah Anda menyelesaikan modifikasi, simpan file Anda dan keluar dari editor teks.
ESC
:!wq
File sumber harus dibuat dengan nama yang cocok dengan apa yang sebelumnya ditentukan index.rst, jika tidak mereka tidak akan dimasukkan dalam hasil akhir.
Semua file sumber harus kompatibel dengan reStructuredText markup language. Untuk informasi lebih lanjut, lihat Primer reStructuredText .
Setelah Anda selesai membuat dokumentasi, Anda dapat menampilkan pekerjaan Anda HTML format dengan menjalankan perintah di bawah ini:
make html
Keluaran akan disimpan dalam direktori ./\_build/htmlyang mencakup semua yang diperlukan untuk melihat file dalam penelusuran web.
Ini menyimpulkan tutorial kami.
Menggunakan Sistem yang Berbeda? Graylog server adalah perangkat lunak manajemen log sumber terbuka siap pakai perusahaan. Ia mengumpulkan log dari berbagai sumber dan menganalisis
Pada kesempatan tertentu, Administrator Sistem mungkin perlu membuat akun pengguna dan membatasi akses mereka untuk hanya mengelola file mereka sendiri melalui sFTP, tetapi tidak
Menggunakan Sistem yang Berbeda? Chamilo adalah sistem manajemen pembelajaran (LMS) gratis dan open source yang banyak digunakan untuk pendidikan online dan kolaborasi tim
Odoo, sebelumnya dikenal sebagai OpenERP, adalah platform bisnis ERP open source yang terkenal. Perusahaan dengan ukuran berapa pun dapat mengambil manfaat dari Odoo, berkat lisnya yang berlimpah
Menggunakan Sistem yang Berbeda? Couch CMS adalah Content Management System (CMS) sederhana dan fleksibel, gratis dan open source yang memungkinkan desainer web untuk mendesain
NextCloud, seperti namanya, adalah alternatif yang menjanjikan dari solusi hosting file sumber terbuka lainnya OwnCloud. Dalam artikel ini, saya akan menunjukkan kepada Anda ho
Menggunakan Sistem yang Berbeda? Netdata adalah bintang yang naik di bidang pemantauan metrik sistem waktu-nyata. Dibandingkan dengan alat lain dengan jenis yang sama, Netdata:
Menggunakan Sistem yang Berbeda? ERP atau Enterprise Resource Planning adalah rangkaian aplikasi perusahaan yang digunakan untuk mengelola proses bisnis inti. ERPNext adalah gratis
Selamat datang di tutorial Vultr lainnya. Di sini, Anda akan belajar cara menginstal dan menjalankan server SAMP. Panduan ini ditulis untuk CentOS 6. Prasyarat Anda akan tahu
Menggunakan Sistem yang Berbeda? Elgg adalah mesin jejaring sosial open source yang memungkinkan penciptaan lingkungan sosial seperti jejaring sosial kampus
Bolt adalah CMS open source yang ditulis dalam PHP. Kode sumber baut di-host di GitHub. Panduan ini akan menunjukkan kepada Anda cara menginstal Bolt CMS pada CentOS 7 Vult yang baru
Bugzilla adalah sistem pelacakan bug sumber bebas dan terbuka yang banyak digunakan oleh berbagai vendor untuk terus meningkatkan softwar mereka
Ikhtisar Artikel ini dimaksudkan untuk membantu Anda mendapatkan kluster Kubernet dan menjalankan dengan kubeadm dalam waktu singkat. Panduan ini akan menggunakan dua server, pada
Menggunakan Sistem yang Berbeda? Pendahuluan Sails.js adalah kerangka kerja MVC untuk Node.js, mirip dengan Ruby on Rails. Itu membuat untuk mengembangkan aplikasi modern ver
Tutorial ini akan membahas proses pemasangan server game Half Life 2 pada Sistem CentOS 6. Langkah 1: Menginstal prasyarat Untuk mengatur ou
Pendahuluan Sistem Linux dilengkapi dengan alat pemantauan secara default seperti top, df, dan du yang membantu memonitor proses dan ruang disk. Namun sering kali, mereka ar
Menggunakan Sistem yang Berbeda? Kolab Groupware adalah aplikasi groupware berbasis web gratis dan open source. Fitur-fiturnya terdiri dari komunikasi email, acara
Menggunakan Sistem yang Berbeda? Koel adalah aplikasi streaming audio pribadi sederhana berbasis web yang ditulis dalam Vue di sisi klien dan Laravel di sisi server. Koe
GDB adalah debugger untuk C, C ++, Objective-C, Pascal, Fortran, Go, D, OpenCL C, Ada, dan Modula-2. CentOS didasarkan pada RHEL (Red Hat Enterprise Linux). Salah satu th
Menggunakan Sistem yang Berbeda? Akaunting adalah perangkat lunak akuntansi sumber terbuka dan gratis yang dirancang untuk usaha kecil dan freelancer. Itu dibangun kecerdasan
Wawasan tentang 26 Teknik Analisis Data Besar: Bagian 1
Banyak dari Anda tahu Switch keluar pada Maret 2017 dan fitur-fitur barunya. Bagi yang belum tahu, kami sudah menyiapkan daftar fitur yang membuat 'Switch' menjadi 'gadget yang wajib dimiliki'.
Apakah Anda menunggu raksasa teknologi untuk memenuhi janji mereka? periksa apa yang belum terkirim.
Baca blog untuk mengetahui berbagai lapisan dalam Arsitektur Big Data dan fungsinya dengan cara yang paling sederhana.
Baca ini untuk mengetahui bagaimana Kecerdasan Buatan menjadi populer di antara perusahaan skala kecil dan bagaimana hal itu meningkatkan kemungkinan untuk membuat mereka tumbuh dan memberi keunggulan pada pesaing mereka.
CAPTCHA telah berkembang cukup sulit bagi pengguna untuk dipecahkan dalam beberapa tahun terakhir. Apakah itu akan tetap efektif dalam deteksi spam dan bot di masa mendatang?
Saat Sains Berkembang dengan kecepatan tinggi, mengambil alih banyak upaya kita, risiko menundukkan diri kita pada Singularitas yang tidak dapat dijelaskan juga meningkat. Baca, apa arti singularitas bagi kita.
Apa itu telemedicine, perawatan kesehatan jarak jauh dan dampaknya terhadap generasi mendatang? Apakah itu tempat yang bagus atau tidak dalam situasi pandemi? Baca blog untuk menemukan tampilan!
Anda mungkin pernah mendengar bahwa peretas menghasilkan banyak uang, tetapi pernahkah Anda bertanya-tanya bagaimana cara mereka mendapatkan uang sebanyak itu? mari berdiskusi.
Baru-baru ini Apple merilis macOS Catalina 10.15.4 pembaruan suplemen untuk memperbaiki masalah tetapi tampaknya pembaruan menyebabkan lebih banyak masalah yang mengarah ke bricking mesin mac. Baca artikel ini untuk mempelajari lebih lanjut
