python-sphinx

8ısı

2cevap

Sfenks TOC ağacını değiştirin

:maxdepth: 2'u içeren bir TOC (index.rst) ile Sphinx project var. Sorun, release bölümü için derinliği 1 olarak azaltmak, böylece ana TOC'deki sürüm notları listesini içermiyor (liste çok uzun). Bu TO

python python-sphinx 2015-11-10

---

6ısı

1cevap

Sfenks ile fonksiyon imzası nasıl oluşturulur?

paket yapısı ve dosyaları bu gibi ayarlanır: $ tree . . ├── doc │   ├── Makefile │   ├── README.md │   ├── _build │   ├── _static │   ├── conf.py │   ├── foo.rst │   ├── index.rst │   └── ma

python documentation python-sphinx 2016-01-17

---

6ısı

1cevap

Sphinx otomatik şişeyi flask-restful API'sini belgelemek için nasıl yapılandırılır?

Bir şişeye yatkın API'yi belgelemek için Sphinx'in otoflask yönergesini kullanmak istediğim bir flask uygulaması var. https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.autohttp.f

python flask python-sphinx flask-restful 2016-01-25

---

0ısı

1cevap

.. literalinclude :: işaretçilerden

Bir C kodu belgelemek için python-sphinx kullanıyorum. doxygen tarafından sunulan özelliklere ilgi duymuyorum, ancak bazen bazı kod parçalarını kod tabanından eklemek istiyorum. .. literalinclude:: ha

documentation python-sphinx code-documentation 2016-03-21

---

0ısı

1cevap

Sphinx autodoc içinde modül üye içeriğini devre dışı bırak

Bir python modülünü autodoc için sphinx kullanıyorum. Örneğin, dosya test.py böyle kodum: Number2Name = {'1': u'中文', '3': u'英文'} """ 字典数据结构 # Dictionary data structures """ Bunda ilk dosyayı yaza

python python-sphinx 2016-03-25

---

3ısı

1cevap

Sphinx TOC'de "genindex" i nasıl ekleyebilirim?

Sfenks, bir belge oluştururken genindex adlı bir dizin oluşturur ve bu nedenle forbids to use that name for a document. Şimdi, bir içerik tablosunda bu dizine nasıl bir link ekleyebilirim? Bu denedim:

python-sphinx 2016-03-26

---

3ısı

1cevap

PyQt 4, dokümanı oku

Şu anda kodlarımın çevrimiçi belgelerini dokümanlar aracılığıyla çevrimiçi olarak alma aşamasındayım, ancak PyQt4'e bağlı modüllerimi işlemek için dokümanı okumanın sorunlu olduğunu düşünüyorum. Farkl

python-2.7 pyqt4 python-sphinx read-the-docs 2016-03-29

---

0ısı

1cevap

Sfenks dokümantasyon değişkenleri

Projelerimden biri için Sphinx Doc kullanarak dokümantasyon oluşturuyorum ve örneğin, IP adresi, bağlantı noktası numaraları ve zaman içinde değişebilen diğer pek çok şey gibi pek çok kez tüm dokümanl

python-sphinx 2016-03-30

---

1ısı

1cevap

Sphinx belgelerine telif hakkı bilgileri ekleyin

Bir Python modülünü belgelemek için Sphinx kullanıyorum. yazarına sahip bir modülüm ve telif hakkı tanımlanmıştır. __author__ = "John Doe <[email protected]>" __copyright__ = "Copyright 2015-2016 Dum

python documentation python-sphinx 2016-04-08

---

0ısı

1cevap

Python: Doğrulama Sınıflar ve Yöntemler uygun şekilde belgelenmiştir (tür, argümanlar, döndürmeler, istisnalar)?

Kodumda pep8, pyflakes ve pylint kullanarak çalışıyorum; Hepsi benim Python kodumun içeriğini ve biçimini doğrular. Şu an için arıyorum, Python kodumun düzgün ve tam olarak yorumlandığını doğrulamaktı

python documentation python-sphinx pylint pep8 2016-04-11

---