Pertanyaan yang diberi tag python-sphinx

Saya benci RST tapi suka sphinx. Apakah ada cara sphinx membaca markdown alih-alih

Saya mencoba menggunakan Sphinx untuk mendokumentasikan proyek 5.000+ line dengan Python. Ini memiliki sekitar 7 modul dasar. Sejauh yang saya tahu, Untuk menggunakan autodoc saya perlu menulis kode seperti ini untuk setiap file dalam proyek saya: .. automodule:: mods.set.tests :members:...

Bagaimana cara memasukkan referensi silang di halaman reST / Sphinx ke sub-header atau jangkar di halaman lain dalam set dokumentasi yang

Sphinx tidak membuat dokumen untuk __init __ (self) secara default. Saya telah mencoba yang berikut ini: .. automodule:: mymodule :members: dan ..autoclass:: MyClass :members: Di conf.py, pengaturan berikut hanya menambahkan docstring __init __ (self) ke kelas docstring ( dokumentasi...

Saya mencoba untuk memulai dengan Sphinx dan sepertinya mengalami masalah tanpa henti. Perintah: docs/sphinx-quickstart Saya menjawab semua pertanyaan dan semuanya bekerja dengan baik. Perintah: docs/ls Semuanya terlihat normal. Hasil:build Makefile source Perintah: sphinx-build -d...

Saya menggunakan sphinx dan plugin autodoc untuk menghasilkan dokumentasi API untuk modul Python saya. Meskipun saya dapat melihat cara mendokumentasikan parameter tertentu dengan baik, saya tidak dapat menemukan contoh cara mendokumentasikan **kwargsparameter. Adakah yang punya contoh bagus...

Tertutup . Pertanyaan ini perlu lebih difokuskan . Saat ini tidak menerima jawaban. Ingin memperbaiki pertanyaan ini? Perbarui pertanyaan sehingga hanya berfokus pada satu masalah dengan mengedit posting ini . Tutup 2 tahun lalu . Perbaiki

Saya mencoba membuat daftar bersarang dengan benar menggunakan kode berikut (mengikuti dokumen Sphinx dan docutils ): 1. X a. U b. V c. W 2. Y 3. Z Saya berharap ini menghasilkan dua OLs tetapi saya mendapatkan output berikut sebagai gantinya: <ol class="arabic simple">...

Saya menggunakan Sphinx untuk mendokumentasikan proyek non-Python. Saya ingin mendistribusikan ./docfolder di setiap submodule, berisi submodule_name.rstfile untuk mendokumentasikan modul itu. Saya kemudian ingin memasukkan file-file itu ke dalam hierarki master untuk membuat spesifikasi untuk...

Saya ingin menambahkan link ke metode di kelas saya dari dalam docstring metode lain di kelas yang sama. Saya ingin tautannya berfungsi di sphinx dan terutama juga di Spyder dan IDE Python lainnya. Saya mencoba beberapa opsi dan hanya menemukan satu yang berfungsi, tetapi itu tidak...

Pembuatan dokumen Sphinx pada read-the-docs gagal dengan kesalahan berikut (log lengkap di bawah): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index'

Silakan unduh file simple.7zdan instal di sphinx Anda untuk mereproduksi masalah apa yang saya jelaskan di sini, untuk mereproduksinya, Anda dapat menjalankan: make clean make html unduh dan instal di sphinx Anda untuk mereproduksi masalah Ada dua artikel di dalam sample/source, isinya sama,...