W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to...
Buduję witrynę Django i szukam wyszukiwarki. Kilku kandydatów: Lucene / Lucene with Compass / Solr Sfinks Wbudowane wyszukiwanie pełnotekstowe Postgresql Wbudowane wyszukiwanie pełnotekstowe MySQl Kryteria wyboru: trafność i ranking wyników szybkość wyszukiwania i indeksowania łatwość użycia...
Nienawidzę RST, ale kocham sfinksa. Czy istnieje sposób, w jaki sfinks czyta markdown zamiast
W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to...
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,...
Jak wstawić odsyłacz na stronie reST / Sphinx do nagłówka podrzędnego lub kotwicy na innej stronie w tym samym zestawie
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...
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...
Używam sphinx i wtyczki autodoc do generowania dokumentacji API dla moich modułów Pythona. Chociaż mogę zobaczyć, jak ładnie udokumentować określone parametry, nie mogę znaleźć przykładu, jak udokumentować **kwargsparametr. Czy ktoś ma dobry przykład jasnego sposobu ich udokumentowania?...
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 2 lata temu . Popraw to pytanie...
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">...
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...
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...
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...
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'
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...