Tracsphinx. Peringkat & Ringkasan
- Nama Penerbit:
- Florent PIGOUT
Tracsphinx. Tag
Tracsphinx. Keterangan
Plugin Sphinx untuk Trac 0.11 Draf pertama untuk sphinx seperti plugin yang mudah digunakan. Tracsphinx mengimplementasikan tugas-tugas dasar untuk mengelola dokumentasi sphinx di Trac.1. Plugin installdownload Sumber plugin, unzip arsip dan ketik perintah easy_install dari folder plugin: $ easy_install setup.py installureRest Proyek Trac. Sebagai administrator, kita sekarang dapat mengaktifkan plugin. Dengan default folder sumber dokumentasi adalah './docs/source' dari repositori proyek. Tetapi dalam banyak kasus, kami akan menimpa jalur ini di bagian dari proyek 'trac.ini' file: Source_dir = / Folder sumber ini digunakan oleh proyek untuk membangun dokumentasi sphinx menggunakan Pembangun web Sphinx. Jika dokumentasi tidak dapat dihasilkan dari trac, kita dapat menentukan jalur dokumentasi yang dihasilkan dengan opsi berikut: doc_dir = / Kami juga dapat mengatur judul navbar dengan opsi berikut: navbar_title = Documentation2. Pembaruan DokumentasiSimple Params ke URL Proyek untuk memperbarui dokumentasi dari folder sumber proyek ke folder proyek Trac './sphinx-docs'. Cukup ketik URL berikut untuk pembaruan: http: // /? Action = refreshin Beberapa kasus dokumentasi tidak dapat dihasilkan seperti dalam kasus berikut: automodule tidak dapat mengimpor bagian dari proyek ketika kita menggunakan automodule, autoclass .. Arahan Beberapa proyek tidak dapat mengimpor harus persyaratan atau konfigurasi. Kemudian sphinx tidak akan menghasilkan dokumentasi proyek dan mengembalikan kesalahan berikut: daftar di luar proyek seperti aplikasi turbogears. Kami saat ini sedang mengerjakan masalah ini dan berharap untuk tujuan solusi segera.3. Dokumentasi navigasi di bilah sisi kanan dari sphinx doc di Trac kita akan menemukan tiga fungsi berikut: * Tabel contentmenu dari konten halaman yang ditampilkan saat ini. * Link relatifSinclude Tautan Proyek Indeks dan Modul, dan tautan sebelumnya / berikutnya. * SearchSimple sphinx seperti fungsi pencarian. Tidak ada JavaScript Di sini kami melakukan pencarian di sisi server.4. URL API Tinjauan plugin mengelola URL dan parameter berikut. Secara default halaman indeks dokumentasi proyek akan ditampilkan. * / / SPHINX Halaman Indeks Default * / / Sphinx? Action = viewitem = Action = Lihat tindakan untuk menampilkan halaman tertentu dari item dokumentasi = Page_Name nama halaman DO menampilkan pencarian_words = kata-kata Pencarian saat ini (disorot di halaman) * / / sphinx? tindakan = indexitem = Genindex Action = Index menampilkan indeks dokumentasi proyek Item = Genindex menampilkan indeks dokumentasi proyek * / / Sphinx? Tindakan = Modulesitem = MODINDEX ACTION = Index menampilkan modul proyek Indeks Item = Genindex menampilkan modul proyek Index5. Next UpdateThis Plugin Versi mengimplementasikan fungsionalitas dasar Sphinx. Jangan ragu untuk mengirim email atau tambalan jika Anda memiliki kebutuhan lebih lanjut atau jika plugin tidak mengelola dokumentasi Sphinx Anda dengan cara yang kami inginkan. Persyaratan: · Python.
Tracsphinx. Perangkat Lunak Terkait
