python-sphinx

8Ciepło

1Odpowiedz

Jak mam wiele wersji mojego dokumentu z sfinksem?

Podobnie jak w dokumentacji Pythona lub Django, w jaki sposób mam wiele wersji mojego dokumentu z Sfinksem? uratowałem moje doc na git, a ja chcę mój użytkownik, aby móc zapoznać się z dokumentacją dl

python-sphinx 2015-03-04

---

21Ciepło

1Odpowiedz

Czytanie Dokumentów zawiera dokumentację autodoc dla członków specjalnych?

Mam moduł z dwoma udokumentowanymi globalnymi członkami specjalnymi. Uruchamianie Sphinx lokalnie tworzy dokumentację, która zawiera ich dokumenty, ale Czytaj Dokumenty nie. Zamiast tego używa wbudowa

python documentation python-sphinx autodoc read-the-docs 2015-01-17

---

7Ciepło

1Odpowiedz

jak renderować glify w bootstrapie w dokumentacji sfinksa?

Używam narzędzia do dokumentacji sphinx do udokumentowania mojej witryny. Chcę wyświetlić, jak powielić coś, klikając określone ikony. Czy mogę dodać bootstrap glyphicons/fontawesome w sfinksie?

twitter-bootstrap font-awesome python-sphinx glyphicons 2015-04-27

---

6Ciepło

1Odpowiedz

Jak mogę uzyskać autosummary Sfinksa, aby wyświetlał dokumenty dla atrybutów instancji?

Wszystkie inne typy (klasy, właściwości, metody itp.) Działają dobrze, ale gdy autosummary dostaje się do atrybutów instancji, powoduje to błąd "WARNING: failed to import AClass.a". Dziwne jest to, że

python documentation python-sphinx 2015-04-27

---

10Ciepło

1Odpowiedz

Sfinks poważne: nieoczekiwany tytuł sekcji - dowolne nagłówki w funkcji docstring w dokumencie

Używanie autodoc i podobnych narzędzi pozwala skompilować dokumentację ze źródła docstrings. To nie wydaje się jednak, aby umożliwić tytuły sekcji dowolna reszta funkcji lub klasy docstrings i tworzy

javascript python python-sphinx restructuredtext autodoc 2015-05-13

---

6Ciepło

1Odpowiedz

Sphinx: Resume lista numeracja po sekcji uwaga

Rozważmy następujący wykaz w ReStructuredText: Broken list example ------------------- #. First do spam #. Then do ``eggs`` .. note:: Nobody expects the Spanish Inquisistion #. The l

python-sphinx restructuredtext continuation numbered-list 2015-03-30

---

10Ciepło

1Odpowiedz

Jak powinienem dokumentować atrybuty klas i obiektów za pomocą stylu Numpy?

Czytałem przez Numpy's documentation standards, i nie wydaje się, aby wspomnieć o atrybutach obiektu - tylko atrybuty klasy. Na przykład, w jaki sposób mogę udokumentować następujące? class ClassA(obj

python numpy documentation scipy python-sphinx 2015-02-10

---

6Ciepło

1Odpowiedz

Rozszerzenie Napoleona Sfinksa: udokumentuj wiele argumentów zwracanych za pomocą poleceń Google Style

To pytanie jest związane z this other one. Proponowane i zaakceptowane rozwiązanie to: Returns: (tuple): tuple containing: arg1: First Argument arg2: Second Argument To

python python-sphinx google-style-guide 2015-07-14

---

13Ciepło

2Odpowiedz

Czy można ukryć argumenty funkcji Pythona w Sphinx?

Załóżmy, że mam następującą funkcję, która jest udokumentowana w Numpydoc style, a dokumentacja jest automatycznie generowane z Sphinxautofunction directive: def foo(x, y, _hidden_argument=None):

python python-sphinx 2015-05-30

---

5Ciepło

1Odpowiedz

W jaki sposób można używać tylko dyrektywy inline, używając roli w python-sphinx?

W python-sfinksie jest only directive, który może być użyty do warunkowego wpływania na dokument zgodnie z jego wyjściem. Na przykład tekst pojawia się tylko w html lub latex. jest używać tak: .. on

inline python-sphinx restructuredtext role 2015-04-12

---