Dartdoc: Fitur Baru: Hasilkan file penurunan harga alih-alih HTML statis

Dibuat pada 7 Agu 2017 · 12Komentar · Sumber: dart-lang/dartdoc

TL;DR
Baris README yang salah membaca untuk menyarankan agar saya dapat menghasilkan file penurunan harga dari dartdoc. Sadar saya tidak bisa dan ingin meminta fitur itu.

Versi yang lebih panjang:
Pertama, tidak memiliki fitur ini tidak menyebabkan masalah.

Kedua, baris berikut di README membuat saya berpikir ada cara untuk melakukannya, tetapi setelah menggali, saya tidak percaya begitu. Jika itu adalah keputusan yang salah, beri tahu saya.

Baris yang disebutkan, penekanan saya.

Secara default , dokumentasi dibuat ke direktori doc/api sebagai file HTML statis .

Saya melihat output pujian bantuan dan dokumentasi dan tidak melihat apa pun yang memungkinkan ini.

Namun, sebagai pendatang baru di Dart. Saya tertarik dengan cara untuk mengambil komentar tertulis yang berpotensi Penurunan Harga dalam kode saya dan merakitnya menjadi file Penurunan Harga.

Kasus Penggunaan yang saya kerjakan di GitHub dan BitBucket dan kedua penyedia menyimpan bagian Wiki mereka di repositori git.

Jadi saya jika saya dapat mengambil komentar dan menghasilkan file penurunan harga, saya dapat mendorongnya ke repo Wiki dari repo proyek saya.

P1 enhancement

Sumber

mcmahonjohn

👍8

Komentar yang paling membantu

Menghidupkan kembali masalah ini. Dukungan generasi penurunan harga untuk dartdoc sekarang pasti ada di radar, dan sejumlah PR baru-baru ini menangani masalah internal dartdoc dengan asumsi pembuatan HTML. Ini termasuk #2072, #2076, #2077, #2078, #2080, #2081, #2085, dan #2086. Saya akan membiarkan @jdkoren mengisi informasi lebih lanjut saat desainnya disempurnakan.

jcollins-g pada 5 Des 2019

🎉3

Semua 12 komentar

Sebagian besar internal dartdoc saat ini menganggap kami sedang membangun HTML, jadi ini tidak mungkin terjadi dalam waktu dekat. Kata-kata dalam README ambigu, saya pikir itu dimaksudkan untuk mengomunikasikan bahwa lokasi penulisan dartdoc dapat dikonfigurasi daripada format output.

jcollins-g pada 12 Sep 2017

👎1

itu akan menjadi fitur yang hebat

Stargator pada 12 Sep 2017

👍2

@jcollins-g Terima kasih atas umpan baliknya. Saya mengerti itu tidak ada sekarang dan kemungkinan tidak ada dalam pikiran untuk masa depan.

mcmahonjohn pada 14 Sep 2017

jcollins-g pada 5 Des 2019

🎉3

Semua permintaan tarik telah digabungkan! Setiap pembaruan pada fitur?

akashgurava pada 21 Apr 2020

@akashgurava kami cukup dekat, Dartdoc dapat menghasilkan halaman sekarang. Ada beberapa hal luar biasa yang mungkin saya pecahkan menjadi masalah terpisah.

jdkoren pada 22 Apr 2020

@jdkoren Setelah kami mencapai titik di mana halaman masuk akal dan kami memiliki semacam pemeriksaan otomatis untuk output, saya pikir kami dapat menutup bug ini dan mungkin mengajukan masalah yang terkait dengan penurunan harga secara terpisah. Apakah kita pada titik itu sekarang atau ada bagian besar yang hilang sebelum kita dapat menyatakan implementasi dasar selesai?

jcollins-g pada 24 Apr 2020

👍2

Saya pikir satu-satunya hal yang kita lewatkan adalah pemeriksaan tempat yang lebih otomatis sebelum kita dapat menyebutnya setidaknya memadai. @mehmetf @jdkoren Bagaimana menurutmu?

jcollins-g pada 30 Sep 2020

Saya tidak yakin apa artinya pemeriksaan tempat otomatis tetapi fungsionalitasnya telah bekerja dengan baik untuk kami sejauh ini. Terima kasih!

mehmetf pada 30 Sep 2020

Nah, jika fungsinya berfungsi dan digunakan secara luas, itu sudah cukup. Saya ingin lebih banyak tes ujung ke ujung tetapi saya selalu ingin lebih banyak tes. :-) Penutupan.

jcollins-g pada 6 Okt 2020

Apa perintah untuk menghasilkan penurunan harga alih-alih dokumen HTML?