epydocgui - Daring di Awan

PROGRAM:

NAMA

epydocgui - antarmuka grafis ke epydoc

RINGKASAN

epidocgui [proyek.prj | modul...]

epidok -h

epidok -V

DESKRIPSI

epidocgui adalah antarmuka grafis ke epydoc, yang menghasilkan dokumentasi API untuk Python
modul dan paket, berdasarkan docstrings mereka. Bahasa markup yang ringan disebut
epitext dapat digunakan untuk memformat docstrings, dan untuk menambahkan informasi tentang bidang tertentu,
seperti parameter dan variabel instan.

Dokumentasi API yang dihasilkan oleh epidocgui terdiri dari sekumpulan file HTML. Dua
subdirektori dibuat untuk dokumentasi publik dan pribadi. Dalam setiap
subdirektori, setiap kelas dan modul didokumentasikan dalam filenya sendiri. Sebuah file indeks, a
file pohon, dan file bantuan juga dibuat. Jika Anda memilih frame pilihan, maka a
daftar isi berbasis frame juga diproduksi.

PILIHAN

proyek.prj
Nama file proyek yang disimpan dengan epidocgui. Catatan file proyek a
daftar modul terkait, dan opsi yang harus digunakan untuk menghasilkan
dokumentasi untuk modul tersebut.

modul...
Daftar modul yang harus didokumentasikan. Modul dapat ditentukan menggunakan
nama modul (seperti os.path), nama file (seperti epidoc/epytext.py), atau direktori
nama (seperti epidok/). Nama direktori menentukan paket, dan diperluas ke
termasuk semua sub-modul dan sub-paket.

-H, --Tolong, --penggunaan, -?
Menampilkan pesan penggunaan.

-V, --Versi: kapan
Cetak versi Epydoc.

HTML FILE

Dokumentasi API yang dihasilkan oleh epidok terdiri dari file-file berikut:

index.html
Titik masuk standar untuk dokumentasi. Biasanya, index.html adalah
file indeks bingkai, yang mendefinisikan tiga bingkai: dua bingkai di sisi kiri
browser berisi daftar isi, dan bingkai utama di sisi kanan
dari jendela berisi halaman dokumentasi. Tapi jika --tanpa bingkai pilihannya adalah
digunakan, maka index.html akan mengarahkan pengguna ke halaman teratas proyek.

m-modul.html
Dokumentasi API untuk sebuah modul. modul adalah nama putus-putus lengkap dari
modul, seperti sys or epidoc.epytext.

c-kelas.html
Dokumentasi API untuk kelas, pengecualian, atau tipe. c apakah lengkap?
nama kelas bertitik, seperti epidoc.epytext.Token or array.ArrayType.

pohon.html
Modul dan hierarki kelas.

index.html
Istilah dan indeks pengenal.

bantuan.html
Halaman bantuan untuk proyek tersebut. Halaman ini menjelaskan cara menggunakan dan menavigasi
halaman web yang diproduksi oleh epydoc.

toc.html
Halaman daftar isi tingkat atas. Halaman ini ditampilkan di kiri atas
bingkai, dan menyediakan tautan ke toc-semuanya.html dan toc-m-modul. Html
file. toc.html tidak dihasilkan jika --tanpa bingkai opsi digunakan.

toc-semuanya.html
Daftar isi untuk keseluruhan proyek. Halaman ini ditampilkan di
bingkai kiri bawah, dan menyediakan tautan ke setiap kelas, jenis, pengecualian, fungsi,
dan variabel yang ditentukan oleh proyek. toc-semuanya.html tidak dihasilkan jika
itu --tanpa bingkai opsi digunakan.

toc-m-modul. Html
Daftar isi untuk sebuah modul. Halaman ini ditampilkan di kiri bawah
frame, dan menyediakan tautan ke setiap kelas, tipe, pengecualian, fungsi, dan
variabel yang ditentukan oleh modul. modul adalah nama putus-putus lengkap dari
modul, seperti sys or epidoc.epytext. toc-m-modul. Html tidak dihasilkan jika
itu --tanpa bingkai opsi digunakan.

epidoc.css
Stylesheet CSS digunakan untuk menampilkan semua halaman HTML.

Secara default, epidok membuat dua subdirektori di direktori keluaran: publik dan swasta.
Setiap direktori berisi semua file yang ditentukan di atas. Tapi jika --tidak-pribadi Option
digunakan, maka tidak ada subdirektori yang dibuat, dan dokumentasi publik ditulis
langsung ke direktori keluaran. dibagi menjadi lima kategori: kesalahan impor; epytext
kesalahan; peringatan epytext; peringatan lapangan; dan kesalahan pemeriksaan. Kapanpun epidok
menemukan kesalahan, itu mengeluarkan pesan peringatan yang menjelaskan kesalahan, dan mencoba untuk
terus menghasilkan dokumentasi.

Kesalahan impor menunjukkan bahwa epydoc tidak dapat mengimpor modul. Kesalahan impor biasanya
mencegah epydoc menghasilkan dokumentasi untuk modul yang dimaksud. Epydoc bisa
menghasilkan kesalahan impor berikut:

Buruk modul nama modul
Epydoc mencoba mengimpor modul, tapi modul bukan nama yang valid untuk Python
modul.

Bisa tidak menemukan a UID untuk tautan-target
Epydoc tidak dapat menemukan objek yang dirujuk oleh konstruksi tautan sebaris
(Aku{...}). Ini biasanya disebabkan oleh kesalahan ketik pada tautan.

Bisa tidak mengimpor modul
Epydoc mencoba mengimpor modul, tapi gagal. Ini biasanya terjadi ketika
modul menimbulkan pengecualian.

fillet tidak tidak ada
Epydoc mencoba mengimpor modul yang ada di fillet, tapi fillet tidak
ada.

Kesalahan epytext disebabkan oleh docstrings epytext yang berisi markup yang tidak valid. Kapanpun
kesalahan epytext terdeteksi, docstring yang dimaksud diperlakukan sebagai docstring plaintext.
Epydoc dapat menghasilkan kesalahan epytext berikut:

Buruk link target.
Target yang ditentukan untuk konstruksi tautan sebaris (Aku{...}) tidak baik-
terbentuk. Target tautan harus berupa pengidentifikasi python yang valid.

Buruk s target.
Target yang ditentukan untuk konstruksi uri sebaris (kamu{...}) tidak terbentuk dengan baik.
Ini biasanya terjadi jika markup sebaris bersarang di dalam target URI.

Fields harus be at itu puncak tingkat.
Daftar bidang (@param, dll.) dikandung oleh beberapa struktur blok lainnya
(seperti daftar atau bagian).

Fields harus be itu terakhir elemen.
Daftar bidang (@param, dll.) tidak berada di akhir docstring.

Pos harus terjadi at puncak tingkat.
Judulnya berisi beberapa struktur blok lainnya (seperti daftar).

Tidak benar paling teruji blok lekukan.
Blok doctest melewati lekukan dari baris prompt awalnya.

Tidak benar menuju lekukan.
Judul bagian tidak rata kiri dengan paragraf di
bagian yang memuatnya.

Tidak benar ayat lekukan.
Paragraf dalam satu blok tidak rata kiri. Kesalahan ini sering
dihasilkan ketika docstrings plaintext diuraikan menggunakan epytext.

Cacat melarikan diri.
Urutan pelarian yang tidak diketahui digunakan dengan konstruksi pelarian sebaris
(E{...}).

daftar harus be bertakuk.
Baris yang tidak diindentasi segera setelah paragraf dimulai dengan peluru daftar.
Epydoc tidak yakin apakah Anda bermaksud memulai item daftar baru, atau dimaksudkan untuk a
paragraf untuk memasukkan kata yang terlihat seperti peluru. Jika Anda bermaksud
sebelumnya, lalu indentasi daftar. Jika Anda menginginkan yang terakhir, maka ubah
pembungkus kata paragraf, atau lepas karakter pertama dari kata itu
terlihat seperti peluru.

imbal '{'.
Docstring berisi kurung kurawal yang tidak seimbang. Epytext mengharuskan semua kurung kurawal
harus seimbang. Untuk memasukkan satu penyangga tidak seimbang, gunakan pelarian
urutan E{lb} (penjepit kiri) dan E{rb} (penjepit kanan).

imbal '}'.
Docstring berisi kurung kurawal yang tidak seimbang. Epytext mengharuskan semua kurung kurawal
harus seimbang. Untuk memasukkan satu penyangga tidak seimbang, gunakan pelarian
urutan E{lb} (penjepit kiri) dan E{rb} (penjepit kanan).

tidak diketahui inline markup menandai.
Tag yang tidak dikenal digunakan dengan konstruksi markup sebaris ( x{...} ).

Salah menggarisbawahi karakter untuk heading.
Karakter garis bawah yang digunakan untuk judul bagian ini tidak menunjukkan
tingkat bagian yang sesuai. Karakter "=" harus digunakan untuk menggarisbawahi
bagian; "-" untuk subbagian; dan "~" untuk subsubbagian.

Peringatan Epytext disebabkan oleh docstrings epytext yang mengandung pertanyaan atau mencurigakan
markup Peringatan epiteks lakukan tidak mencegah docstring tersebut diurai.
Epydoc dapat menghasilkan peringatan epytext berikut:

Mungkin format yang salah bidang barang.
Epytext mendeteksi garis yang terlihat seperti item bidang, tetapi tidak benar
diformat. Ini biasanya terjadi ketika tanda titik dua (":") tidak disertakan
di tag lapangan.

Mungkin menuju salah ketik.
Epytext mendeteksi sepasang garis yang terlihat seperti heading, tetapi jumlah
karakter garis bawah tidak sesuai dengan jumlah karakter dalam judul.
Jumlah karakter dalam dua baris ini harus sama persis agar menjadi
dianggap sebagai judul.

Peringatan bidang disebabkan oleh docstring epytext yang berisi bidang yang tidak valid. Isi
bidang yang tidak valid umumnya diabaikan. Epydoc dapat menghasilkan bidang berikut:
peringatan:

@param untuk tidak dikenal parameter berhenti.
Bidang @param digunakan untuk menentukan jenis parameter yang bukan
termasuk dalam tanda tangan fungsi. Ini biasanya disebabkan oleh salah ketik
nama parameternya.

label melakukan tidak mengharapkan an argumen.
tag lapangan label digunakan dengan argumen, tetapi tidak membutuhkannya.

label diharapkan an argumen.
tag lapangan label digunakan tanpa argumen, tetapi membutuhkan satu.

@Tipe untuk tidak dikenal parameter berhenti.
Bidang @type digunakan untuk menentukan jenis parameter yang tidak disertakan
dalam tanda tangan fungsi. Hal ini biasanya disebabkan oleh salah ketik di
nama parameter.

@Tipe untuk tidak dikenal variabel adalah.
Bidang @type digunakan untuk menentukan jenis variabel, tetapi tidak yang lain
informasi yang diketahui tentang variabel tersebut. Ini biasanya disebabkan oleh salah ketik
nama variabel.

tidak diketahui bidang label label.
Sebuah docstring berisi bidang dengan tag yang tidak diketahui label.

definisi ulang of bidang.
Beberapa tag bidang menentukan nilai bidang dalam docstring yang sama, tapi bidang
hanya dapat mengambil satu nilai.

Kesalahan inspeksi dihasilkan jika epydoc menemui masalah saat mencoba memeriksa
properti dari objek yang didokumentasikan. Sebagian besar kesalahan inspeksi tidak mencegah epydoc
dari mendokumentasikan objek yang bersangkutan. Epydoc dapat menghasilkan inspeksi berikut:
kesalahan:

The parameter of metode do tidak pertandingan metode dasar.
Parameter metode tidak berdokumen metode tidak cocok dengan parameter
dari metode kelas dasar metode dasar bahwa itu menimpa. Hasil dari, metode
tidak mewarisi dokumentasi dari metode dasar. Jika selisih
parameter disengaja, maka Anda dapat menghilangkan peringatan dengan menambahkan a
(mungkin kosong) docstring to metode.

peta dokumen tidak bisa menambahkan a mengetik
Epydoc berusaha mendokumentasikan objek dengan tipe yang tidak diketahui. Kesalahan ini adalah
biasanya dihasilkan oleh paket dan modul yang memanipulasi impor
mekanisme, sehingga mengimpor modul menghasilkan beberapa jenis objek lainnya.

UID konflik terdeteksi: uid
Dua objek berbeda diberi pengidentifikasi unik yang sama oleh epydoc. Ini
dapat menyebabkan epydoc mengganti dokumentasi satu objek dengan
dokumentasi objek lain yang diberi pengenal unik yang sama.
Namun, ini biasanya hanya akan menimbulkan masalah jika dua objek dengan yang sama
pengidentifikasi unik adalah modul atau kelas, dalam hal ini API
halaman dokumentasi untuk satu objek akan menimpa halaman dokumentasi API untuk
objek lainnya.

obyek muncul in beberapa builtin modul
Saat mencoba menentukan modul mana yang mendefinisikan objek bawaan obyek,
epydoc menemui banyak kandidat, dan tidak dapat memutuskan mana
calon itu benar. Dalam hal ini, epydoc secara sewenang-wenang memilih yang pertama
kandidat yang ditemukannya.

obyek muncul in beberapa .py modul
Saat mencoba menentukan modul mana yang mendefinisikan objek bawaan obyek,
epydoc menemui banyak kandidat, dan tidak dapat memutuskan mana
calon itu benar. Dalam hal ini, epydoc secara sewenang-wenang memilih yang pertama
kandidat yang ditemukannya.

obyek muncul in beberapa .begitu modul
Saat mencoba menentukan modul mana yang mendefinisikan objek bawaan obyek,
epydoc menemui banyak kandidat, dan tidak dapat memutuskan mana
calon itu benar. Dalam hal ini, epydoc secara sewenang-wenang memilih yang pertama
kandidat yang ditemukannya.

Bisa tidak menemukan a modul untuk obyek
Epydoc tidak dapat menentukan modul mana yang didefinisikan obyek. Jika obyek adalah
fungsi, maka ini akan mencegah epydoc menghasilkan dokumentasi apa pun untuk
obyek, karena tidak tahu di halaman mana dokumentasi harus diletakkan.
Jika tidak, ini akan mencegah dokumentasi untuk obyek dari menyertakan tautan
ke modul yang berisi.

Gunakan epydocgui online menggunakan layanan onworks.net