python-sphinx

10Ciepło

1Odpowiedz

Sfinks - łączenie automodułu i autoklasu

O ile czegoś nie brakuje, Sphinx's automodule będzie dokumentował tylko elementy modułu, a nie atrybuty klas zdefiniowanych w tym module. Czy istnieje sposób automatycznie dostać zachowanie automodule

python python-sphinx 2012-12-14

---

5Ciepło

1Odpowiedz

sfinks typy powrotu metody z linkami

Korzystanie Cython wraz z -Xembedsignature=True może przynieść podpisów docstrings w formie: | mymethod(...) | MyCythonModule.mymethod(self, param1, MyCythonType param2, param3=None) -> SomeResultTy

python cython python-sphinx 2012-12-17

---

9Ciepło

1Odpowiedz

Python: Sphinx: Jak automatycznie włączyć wszystkie klasy, metody i funkcje do dokumentacji sfinksa?

Powiel możliwe: Sphinx — combining automodule and autoclass próbuję utworzyć dokumentacji HTML dla projektu zawierającego kilka tysięcy klas przy użyciu Sfinks i to plugin AutoDoc. Sphinx-apidoc tworz

python python-sphinx 2013-01-02

---

6Ciepło

1Odpowiedz

ImportError dla mojego kodu na Readthedocs

Próbuję połączyć moją dokumentację Sfinksa z czytaniem dokumentów. Mogę zbudować dokumentację lokalnie, ale gdy próbuję Przeczytałem docs automatycznego generowania dokumentacji pojawia się następując

django documentation python-sphinx importerror 2012-11-14

---

5Ciepło

1Odpowiedz

Jak mogę wyświetlić listę nieudokumentowanych członków za pomocą Sphinx/Autodoc?

Używam sfinksa z rozszerzeniem autodoc, i chcę wygenerować listę tylko zawierającą nieudokumentowane funkcje członkowskie w kilku modułach, a nie udokumentowane elementy. mogę z powodzeniem utworzyć l

python python-sphinx 2013-01-03

---

8Ciepło

1Odpowiedz

Rozszerzenie procesora dokumentacji Sphinx działa inaczej dla wyjścia HTML i LaTeX?

Mam proste rozszerzenie Sphinx następująco: from docutils import nodes from docutils.parsers.rst import directives from sphinx.util.compat import Directive class testnode(nodes.Element): def

python python-sphinx 2012-11-15

---

7Ciepło

3Odpowiedz

Otrzymywanie pojedynczych plików Github

Mam zamiar zbudować wtyczkę dla wtyczki systemu dokumentacji Sphinx, która pokazuje nazwy i linki profilu Github osób, które przyczyniły się do strony dokumentacji. Github ma tej funkcji wewnętrznie C

python github python-sphinx github-api 2012-11-17

---

10Ciepło

2Odpowiedz

Jak zapobiec tworzeniu przez sfinksa hiperłącza?

W moich dokumentach od czasu do czasu używam adresów URL "śmieci" jako przykładów i nie chcę, aby były one linkami do nikąd. Czy istnieje jakakolwiek składnia, aby te adresy nie były hiperlinkami?

python-sphinx restructuredtext 2012-12-04

---

6Ciepło

1Odpowiedz

Jak przesłonić parametry konstruktorów w Sphinx przy pomocy autodoc?

Powiedzmy mam klasy jak poniżej: class MyClass(object): """ Summary docs for my class. Extended documentation for my class. """ def __init__(self, *args): self.values = np.

python python-sphinx 2012-12-09

---

22Ciepło

1Odpowiedz

Brak generowania indeksu modułu "modindex" podczas używania Sphinx

Mam problemy z tworzeniem katalogu dokumentów (html) przy użyciu sphinx-build. Próbowałem sphinx-build -b html source build jak również make html ale w obu przypadkach tylko html pliki search.html

python-sphinx 2012-12-12

---