python-sphinx

13ısı

2cevap

Sfenks'te Python işlev argümanlarını gizlemek mümkün mü?

varsayalım ben Numpydoc style belgelenmiştir aşağıdaki işlevi vardır ve dokümantasyon otomatik oluşturulan ile Sphinxautofunction directive: Ben kamu API parçası olarak gizli argüman reklamını yapmak

5ısı

2cevap

Sphinx'te bir tabloya bir sınıf ekleyin?

Yeniden bir tablo var ve Sphinx ile HTML derlerken bir sınıf eklemek istiyorum. the docs'a göre, tablodan önce .. class:: yönergesinin eklenmesi, sınıfı tabloya eklemelidir, ancak bunun yerine bir tan

8ısı

1cevap

Sfenks ile dokümümün birden çok sürümüne nasıl sahip olabilirim?

Python veya django belgelerinde olduğu gibi, sfenks ile dokümümün birden çok sürümüne nasıl sahip olabilirim? yardım

21ısı

1cevap

Dokümanlar Özel üyeler için autodoc belgelerini de okuyor musunuz?

İki belgeli global özel üyeye sahip bir modülüm var. Sfenks'i yerel olarak çalıştırmak, belgelerini içeren belgeleri oluşturur, ancak Dokümanların okunmadığını okuyun. Bunun yerine yerleşik türün belg

7ısı

1cevap

Sfenks belgelerinde bootstrap gliflerini nasıl render edilir?

Web sitemi belgelemek için sphinx dokümantasyon aracını kullanıyorum. Belirli simgeleri tıklayarak bir şeyi nasıl yeniden üreteceğinizi listelemek istiyorum. Sfenkste bootstrap glyphicons/fontawesome

5ısı

2cevap

Özelleştirme Sfenks arama kutusuna

basit bir yolu var mı oluşturmamak için (yani tamamen yeni bir tema yaratmadan) arama kutusu olmadan HTML sayfaları üretir, böylece Sfenks özelleştirmek için? searchbox şablonu

5ısı

1cevap

Sfenks 1.2.3 kullanarak kod blokları

yılında Sfenks değişken değiştirme ve bu RST pasajı verilen: .. code-block:: xml <foo> <bar>|version|</bar> </foo> ve conf.py I var: version = '1.0.2' Yukarıdaki RST pasajı şekild

10ısı

1cevap

sphinx Şiddetli: beklenmedik bölüm başlığı - işlev yönergelerindeki isteğe bağlı başlıklar

autodoc ve benzeri araçların kullanılması, bir kaynaktan kaynak belgelerini derlemenize olanak sağlar docstrings. Ancak, işlev veya sınıf Docstringler keyfi Rest bölüm başlıkları izin görünüyor ve hat

10ısı

1cevap

Numpy'nin stilini kullanarak sınıf ve nesne özelliklerini nasıl belgelemeliyim?

Numpy's documentation standards aracılığıyla okuyorum ve nesne özniteliklerinden bahsetmiyor gibi görünüyor - yalnızca sınıf özellikleri. Örneğin, aşağıdakileri nasıl belgeleyebilirim? class ClassA(ob

7ısı

1cevap

Sphinx doc kullanarak Ref'i bir etiketle kullanamazsınız.

Sphinx-doc'ın Ref işlevini kullanmayla ilgili bir sorunum var, bir paragrafın üzerine bir etiket koydum ve sonra bu etikete başka bir belgeden bağlanmayı denedim ama aynı projenin içinde. i bir belged