python-sphinx

10Ciepło

5Odpowiedz

wartości Sphinx dla atrybutów zgłaszane jako Żaden

Gdy używam Sphinx autodoktora udokumentować klasę, wartości atrybutów są zawsze podano, (jak to mówi, że powinien here pod # 437), ale zawsze jako „= None” Attribute = None Some Documentation I

28Ciepło

1Odpowiedz

jak wyświetlić atrybuty instancji w dokumencie Sphinx?

Czy jest jakiś sposób, aby automatycznie wyświetlić zmienne var1 i var2 i ich wartości początkowe w dokumentacji Sphinx? class myClass(): """ Description for class """ def __init

5Ciepło

1Odpowiedz

Dzielenie dokumentu źródłowego w Sphinx (tj. Hierarchia plików zarządzających)

Jaki jest właściwy sposób podziału dokumentu źródłowego w Sphinx? Mam dużego pliku, nazwijmy to file1.rst, którego struktura jest tak: Section 1 ********* Subsection 1 ============ Subsection 2

13Ciepło

3Odpowiedz

Dodanie skryptu javascript oznacz miejsce w taki sposób, aby działało dla każdego pliku w dokumentacji sfinksa.

Używam Sphinx do pisania notatek. Używam rozszerzenia Mathjax dla Math w notatkach. Domyślny rozmiar matematyki jest trochę większy niż chciałbym. Na stronie Mathjax znalazłem, że mogę zmienić ten roz

11Ciepło

3Odpowiedz

Osadzanie HTML w restructuredtext na PyPI stronach pakietu

W Sphinx Wiem, że można to zrobić: .. raw:: html <div style="margin-top:10px;"> <iframe width="560" height="315" src="http://www.youtube.com/embed/_EjisXtMy_Y" frameborder="0" allowfullscr

24Ciepło

2Odpowiedz

Jak dodać dodatkowe odstępy między nagłówkiem sekcji a akapitem

Chcę mieć więcej miejsca między nagłówkiem i akapitem oraz między akapitami. Nie chcę, aby było to ustawienie globalne, ale chcę go używać wszędzie tam, gdzie jest to wymagane. Doceń wszelkie sugestie

14Ciepło

2Odpowiedz

Jak dokumentować parametry funkcji Pythona za pomocą sphinx-apidoc

Próbuję wyczyścić moją dokumentację kodu Pythona i postanowiłem użyć sphinx-doc, ponieważ wygląda dobrze. Lubię, jak można odwołać innych klas i metod ze znacznikami typu: :class:`mymodule.MyClass` Ab

9Ciepło

3Odpowiedz

W dokumentacji Sphinx, w jaki sposób mogę odwrócić kolejność roszczenia, które jest dostarczane przez opcję flagi "glob"?

Czy ktoś wie jakąkolwiek opcję zamówienia toctree w porządku malejącym nazw plików? W przypadku rosnącej kolejności, możemy użyć: glob: opcja tak: .. toctree: :glob: 2011* Byłby przydatny

9Ciepło

1Odpowiedz

Zobacz docstrukcje reStructuredText (Sphinx) w iPythonie?

Czy istnieje sposób, aby mieć ipython pełni czynią reStructuredText (dla Sphinx) docstrings po wpisaniu następujących czynności: help foo lub: foo? Uważam to Super rozpraszać, aby spróbować odczyt

10Ciepło

3Odpowiedz

Instalowanie środowiska Python/Sphinx w systemie Windows?

Używamy do dokumentacji w środowisku Pythona Linux/OSX, ale mamy kogoś w systemie Windows, który chciałby uzyskać środowisko, w którym może edytować i budować dokumentację Sphinx. Czy można skonfiguro