2015-01-17 9 views
21

Mam moduł z dwoma udokumentowanymi globalnymi członkami specjalnymi.Czytanie Dokumentów zawiera dokumentację autodoc dla członków specjalnych?

Uruchamianie Sphinx lokalnie tworzy dokumentację, która zawiera ich dokumenty, ale Czytaj Dokumenty nie. Zamiast tego używa wbudowanej dokumentacji typu.

Próbowałem obu stylów: #: i docstring po definicji. Wielokrotnie czytałem dokumentację autodoc oraz Read the Docs entry on it. Nie wiem, czego mi brakuje, ponieważ nie widzę żadnych błędów kompilacji w Read the Docs.

Wszelkie pomysły?

+0

możesz wyświetlić pełne polecenie, którego używasz do kompilacji dokumentu? –

+0

Z https://readthedocs.org/projects/argf/builds/3296530/: 'python /home/docs/checkouts/readthedocs.org/user_builds/argf/envs/latest/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language = en. _build/html' –

+0

Miałem tu przyjść i powiedzieć ci to samo, co w "Sphynxie", z '#:' bezpośrednio przed członkiem ... ale wygląda na to, że już to wypróbowałeś, więc zamiast tego +1 w nadziei, że dostaniesz dobrą odpowiedź :) –

Odpowiedz

1

W przypadku korzystania rozszerzenie Napoleon obsłużyć NumPy lub Google stylu docstrings można ustawić flagę konfiguracji to w conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

Jeśli dobrze pamiętam jest tam również dyrektywa dla AutoDoc:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

Poprzez wdrożenie tej metody masz drobnoziarnista wybór, którego członkiem będzie zawarte w docs, a które nie.

+0

https://stackoverflow.com/questions/15903577/include-specific-special-methods-in-sphinx – marscher

Powiązane problemy