python-sphinx

0Hitze

2Antwort

Sphinx Autodoc-Skip-Member-Handler: kann nicht zeigen __init __() bei der Verwendung von Napoleon

Ich möchte die Docstrings für __init__() in meiner Sphinx-generierten Dokumentation enthalten. Ich folgte the accepted answer to this stackoverflow question, um einen Handler für autodoc-skip-member h

python python-sphinx 2016-03-28

---

3Hitze

1Antwort

PyQt 4 import in read-the-docs

Ich bin gerade dabei, die Dokumentation meines Codes über read-the-docs online zu bekommen, aber das Lesen der Dokumente zur Verarbeitung meiner PyQt4-abhängigen Module scheint problematisch zu sein.

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

---

0Hitze

1Antwort

Sphinx-Dokumentationsvariablen

Ich erstelle Dokumentationen mit Sphinx Doc für eines meiner Projekte und ich benutze oft einige Wörter im ganzen Dokument, zum Beispiel - IP-Adresse, Portnummern und viele andere Dinge, die sich im L

python-sphinx 2016-03-30

---

1Hitze

1Antwort

Sphinx: Platzieren Sie die Überschrift zwischen Automethod-Einträgen

Ich benutze Sphinx, um eine Klasse mit vielen Methoden zu dokumentieren. Ich würde zu einer Gruppe wie die Methoden in einzelne Abschnitte, getrennt durch Header, wie folgt aus: .. autoclass:: MyClass

python-sphinx 2016-04-03

---

3Hitze

1Antwort

Dokumentieren von Python-Koroutinen mit Sphinx autodoc

Ich fange an, mein erstes asyncio-basiertes Projekt mit Sphinx zu dokumentieren. Ich habe bemerkt, dass einige Projekte dieses "coroutine" Präfix vor einigen Methoden haben und ich möchte das gleiche

python-sphinx python-asyncio 2016-04-04

---

5Hitze

1Antwort

Dokumentieren CMakeLists.txt und benutzerdefinierte oder lokale .cmake Dateien

Was sind gute Möglichkeiten, um mein Projekt CMakeLists.txt Dateien und lokale Projekt .cmake Dateien zu dokumentieren? Es gibt eine zwei Jahre alte Frage/Antwort Documenting CMake scripts, die ich im

cmake documentation python-sphinx 2016-04-05

---

1Hitze

1Antwort

Copyright-Informationen zu Sphinx-Dokumentation hinzufügen

Ich benutze Sphinx, um ein Python-Modul zu dokumentieren. Ich habe ein Modul, das Autor und copyright definiert hat. __author__ = "John Doe <[email protected]>" __copyright__ = "Copyright 2015-2016 D

python documentation python-sphinx 2016-04-08

---

0Hitze

1Antwort

Python: Validierende Klassen und Methoden sind korrekt dokumentiert (Typ, Argumente, Rückgabe, Ausnahmen)?

Ich durchlaufe meinen Code mit Pep8, Pyflakes und Pyint; Alle validieren den Inhalt und das Format meines Python-Codes. Was ich jetzt suche, ist zu validieren, dass mein Python-Code richtig und vollst

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

---

3Hitze

1Antwort

ReadTheDocs nicht analysieren DocStrings in Python-Module (Sphinx)

Ich habe Open-Sourcing einige meiner Code, aber die Dokumentation wird nicht ordnungsgemäß auf ReadTheDocs ordnungsgemäß trotz der Arbeit mit dem Makefile erstellt von sphinx-quickstart und make html

python-sphinx read-the-docs 2016-04-17

---

5Hitze

1Antwort

Unterschied zwischen sphinxcontrib.napoleon und numpy.numpydoc

Ich schreibe Dokumentation für ein Python-Projekt mit Numpy-style docstrings. numpydoc und napoleon sind zwei Sphinx-Erweiterungen, die Numpy-artige Docstrings analysieren, um Dokumentation zu generie

python numpy documentation python-sphinx 2016-04-19

---