Pytania otagowane jako python-sphinx

Sphinx to narzędzie ułatwiające tworzenie inteligentnej i pięknej dokumentacji. Sphinx nadaje się szczególnie do dokumentacji Pythona, ale jest to narzędzie ogólnego przeznaczenia, którego można użyć do dokumentowania wszystkiego.

6
Sphinx autodoc nie jest wystarczająco automatyczny
Próbuję użyć Sphinx do udokumentowania ponad 5000 liniowego projektu w Pythonie. Posiada około 7 modułów bazowych. O ile wiem, aby korzystać z autodoc, muszę napisać taki kod dla każdego pliku w moim projekcie: .. automodule:: mods.set.tests :members: :show-inheritance: Jest to zbyt uciążliwe, ponieważ mam wiele plików. Byłoby znacznie łatwiej, gdybym …
5
Jak użyć autodoc Sphinx do udokumentowania metody __init __ (self) klasy?
Sphinx domyślnie nie generuje dokumentów dla __init __ (self). Próbowałem następujących rzeczy: .. automodule:: mymodule :members: i ..autoclass:: MyClass :members: W conf.py ustawienie następujących elementów tylko dołącza __init __ (self) docstring do klasy docstring ( dokumentacja Sphinx autodoc wydaje się zgadzać, że jest to oczekiwane zachowanie, ale nie wspomina o …
7
sphinx-build fail - autodoc nie może zaimportować / znaleźć modułu
Próbuję rozpocząć pracę ze Sphinxem i wydaje mi się, że mam nieustające problemy. Komenda: docs/sphinx-quickstart Odpowiadam na wszystkie pytania i wszystko działa dobrze. Komenda: docs/ls Wszystko wygląda normalnie. Wynik:build Makefile source Komenda: sphinx-build -d build/doctrees source build/html Wydaje się, że działa. Udało mi się otworzyć plik index.html i zobaczyć „powłokę” …
2
Jak utworzyć zagnieżdżoną listę w reStructuredText?
Próbuję utworzyć poprawnie zagnieżdżoną listę przy użyciu następującego kodu (następujące dokumenty Sphinx i docutils ): 1. X a. U b. V c. W 2. Y 3. Z Spodziewam się, że spowoduje to dwa OLs, ale zamiast tego otrzymuję następujące dane wyjściowe: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol class="loweralpha …
6
Czy sphinx może tworzyć linki do dokumentów, które nie znajdują się w katalogach poniżej dokumentu głównego?
Używam Sphinx do dokumentowania projektu innego niż Python. Chcę rozprowadzić ./docfoldery w każdym submodule_name.rstmodule podrzędnym, zawierające pliki dokumentujące ten moduł. Następnie chcę zassać te pliki do głównej hierarchii, aby utworzyć specyfikację dla całego projektu. To znaczy: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src …
3
Link do metody klasy w docstringu języka Python
Chcę dodać link do metody w mojej klasie z poziomu dokumentacji innej metody tej samej klasy. Chcę, aby link działał w sfinksie, a preferencyjnie również w Spyder i innych Python IDE. Wypróbowałem kilka opcji i znalazłem tylko jedną, która działa, ale jest uciążliwa. Załóżmy, że następująca struktura w mymodule.py def …
4
Sformatuj tekst w linku w reStructuredText
Jak formatujesz tekst w oznaczonym linku w reStructuredText? W szczególności chciałbym najpierw wygenerować następujący kod HTML: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> Wynik powinien wyglądać następująco: optparse.OptionParser dokumentacja gdzie część „optparse.OptionParser” jest zapisana czcionką o stałej szerokości. próbowałem ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ jednak to dało <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ który …
1
Kompilacja Read-the-docs kończy się niepowodzeniem, gdy „nie można zaimportować nazwy„ PackageFinder ”z„ pip._internal.index ””
Kompilacja dokumentów Sphinx na plikach read-the-docs kończy się niepowodzeniem z następującym błędem (pełny dziennik poniżej): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Czy zrobiłem coś złego, czy jest to błąd w czytaniu dokumentów? Lokalna kompilacja dokumentów Sphinx działa dobrze. Wypełnij dziennik błędów w plikach read-the-docs: Read the Docs build …
2
Dlaczego plik HTML przekonwertowany z pierwszego pliku zawierającego znak zapytania nie może zostać wyświetlony w przeglądarce, kiedy należy kliknąć katalog?
Pobierz plik simple.7zi zainstaluj w swoim sfinksie, aby odtworzyć problemy, które tu opisałem, aby je odtworzyć, możesz uruchomić: make clean make html pobierz i zainstaluj w swoim sfinksie, aby odtworzyć problemy Są dwa artykuły sample/source, treść jest taka sama, jedyną różnicą jest tytuł. cd sample ls source |grep "for-loop" What …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.