Sphinx

Gdy utworzony po raz pierwszy, to głównym celem było służyć jako generator dokumentacji dla Pythona jest kodem własnym.
Od tego czasu projekt osiągnął status kultowego w świecie rozwoju, jest jednym z najbardziej odwołuje wpływów w większości automatycznych generatorów dokumentacji wokół, niezależnie od języka.
Dziś, oprócz tylko Pythona, Sfinks może być również używany z C i C ++ kod, jak również.

Co nowego w tym wydaniu:

• Dodaj dyrektyw wygodę i role do C ++ domeny: Dyrektywa `` CPP: var`` jako alias `` cpp: member``, roli ``: cpp: var`` jako alias ``: cpp: członek ``, `any` i rola dla odsyłacza do jakiegokolwiek C ++ declaraction.
• : confval: `source_suffix` wartość config może być teraz lista wielu przyrostków
.
• Dodaj możliwość określenia źródła przez źródłowego parsera przyrostkiem z: confval:. `Source_parsers` wartości config
• Nowy budowniczy, AppleHelpBuilder, dodano, że buduje firmy Apple Pomoc Książki.

Co nowego w wersji 1.2.3 / 1.3b3:

• Dodane `` sphinx.version_info`` krotki do programowej kontroli wersji Sphinx.

Co nowego w wersji 1.1.3:

• Naprawiono błąd z niektórymi ustawieniami: confval:. `Modindex_common_prefix`
• Stała obsługa i `` `` -D`` opcje -A`` na Python 3.
• Uznane i ostrzec o okrągłych toctrees, zamiast biegać do błędów rekursji.
• Restore kompatybilność z docutils bagażniku.
• Poprawiono HTMLHelp linki Wpis indeksu ponownie.
• Poprawiono błędy atrybutów podniesienie inheritance_diagram na builtins.
• Poprawiono ulega awarii podczas oddawania komentarzy lub warunki samotnych w słowniku.
• Poprawiono pomocy HTML mapowanie język / kodowania dla wszystkich Sphinx obsługiwanych języków.

Co nowego w wersji 1.1:

• Funkcje dodał:
• Wsparcie 3.x Dodane Python.
• Nowe budowniczych i podsystem.
• Zmiany niezgodne:
• : najpierw: reż: `py: module` dyrektywa nie ma wyjścia jego` `platform`` wartość opcji więcej. (To była jedyna rzecz, że dyrektywa nie wyjście, a więc dość niespójne.)
• Usunięto wsparcie dla starszych wersji zależności.
• Nowe lokalizacje:
• Dodane Szwedzki locale.
• Dodane Irański locale.
• Dodane Łotewski locale.
• Dodane Nepalski locale.
• Dodano koreańskie ustawienia regionalne.
• Dodane Estoński locale.

Co nowego w wersji 1.0.8:

• tracebacks Fix dla AttributeErrors w autosummary generacji.
• Fix `` abbr`` rolę, gdy skrót ma znaki nowej linii w nim.
• Fix linki do wyników z niestandardowych typów obiektów wyszukiwania.
• numery linii Fix zgłaszane ostrzeżeń o referencje niezdefiniowanych.
• Fix C ++ tablicy definicje i argumenty szablonu, które nie są wpisywane nazwy.
• Zezwalaj przypisy na nagłówki sekcji w wyjściu LaTeX.
• Pozwól słowo aby być połączone poprzez intersphinx.
• Zezwalaj znaków Unicode w nazwach symbolicznych lista produkcji.
• Dodaj obojętne odwiedzających do węzłów Graphviz dla tekstu i człowieka.
• bug Fix plik obrazu powielania.
• parsowanie Fix wielu podpisów w C ++ domeny.
• Ignoruj ​​pliki blokady Emacsa przy poszukiwaniu plików źródłowych.
• Zezwalaj .pyw rozszerzenie dla przywozowe modułów w autodoktora.
• Użyj `` $ (MAKE) `` w generowanych plików Makefile szybkiego startu.
• pasek boczny Szerokość pole wyszukiwania spójne w przeglądarkach.
• Rozstaw Fix skupionych postaci w HTML.
• Bezpieczne drukowanie, gdy je kodować wiadomości SphinxError do sys.stderr.
• Błąd wyjścia Fix LaTeX z dokumentu bez sekcjach, ale cel łącza.
• poprawnie traktować wbudowane deskryptory Sposób metod autodoktora.
• Zatrzymaj monkeypatching moduł odpychania tekstu Pythona.
• Viewcode działa teraz poprawnie z plików źródłowych, które mają kodowanie spoza zestawu ASCII.
• Szanuj flagi `noindex`` opcję` w py. Dyrektyw modułu
• IndexErrors Fix nieistniejącego linie przy tym z: rst: reż:. `Literalinclude`

Ciągi
• Funkcja Szacunek niestandardowy / separator parametrów metody.
• niezgodność Fix JS z jQuery & gt;. = 1.5
• podwójne kodowanie zrobić Fix pisząc HTMLHelp .hhk plików.
• Nie stosować w analizowanych-Smartypants dosłownym bloków.
• C ++ domeny obsługuje definicji tablicy.

Co nowego w wersji 1.0.6:

• Fix traceback w Pythonie domeny dla pustych celów odsyłaczy.
• Rozwiąż problemy z wyświetlaniem dosłowne bloku w przeglądarkach Chrome.
• Pomoc sortowania ograniczony zakres znaków akcentowanych w ogólnym indeksie i słowniczek.
• Spróbuj dekodowania i `` `` -D`` -A`` argumenty wiersza poleceń z preferowanym kodowaniem ustawień regionalnych.
• Należy przestrzegać: confval:. `Locale_dirs` przy poszukiwaniu pliku z tłumaczeniem JS
• Dodaj specjalny kod dla lepszego wsparcia japońskich dokumentów w budowniczego LaTeX.
• regresji # 77: Jeśli jest tylko jeden parametr podawany z ``: param. `` Znaczników, lista kula jest teraz stłumione ponownie
• Fix brakujące znaki końca akapitu w wyjściu LaTeX w pewnych sytuacjach.
• emitują `` zdarzenia autodoktora-proces-docstring`` nawet dla obiektów bez docstring tak, że może dodać treść.
• W budowniczego LaTeX, nie tylko dosłowne bloki wymagają innego traktowania tabeli, ale także kilka innych elementów podobnych do listy bloku.
• tracebacks Fix w rozszerzeniu viewcode dla obiektów Pythona, które nie mają prawidłowy podpis.
• Fix dziwne reportings z numerami linii ostrzeżeń wygenerowanych z autodoktora-włączone docstrings, ze względu na różne zachowania w zależności od wersji docutils.
• Kilka poprawek do ++ domeny C.

Co nowego w wersji 1.0.5:

• Dodaj style CSS wymagane przez docutils 0,7 do wyrównanych obrazów i figur.
• W Makefile generowane przez wyjście LaTeX, nie usuwaj plików pdf na czyste; mogą one być wymagane obrazów.
• Wyjście Fix LaTeX generowane dla bloków liniowych.
• Zezwalaj `` .pyw`` jako rozszerzenie pliku źródłowego.

Co nowego w wersji 1.0.4:

• Otwarte zapasy intersphinx w trybie binarnym na Windows, od wersji 2 zawiera dane zlib-skompresowanych.
• Zezwalaj dając non-URI dla plików lokalnych JavaScript, np w rozszerzeniu JSMath.
• traceback Fix, gdy `` intersphinx_mapping`` jest pusty.

Co nowego w wersji 1.0.3:

• Fix zewnętrznego łącza wewnętrzne w porównaniu z wyróżnieniem dla linków pochodzących z docutils tabela-of-zawartość.
• Fix opcję maxdepth`` `` `` dla toctree () `` szablon wywoływane, gdy używana z `` załamanie = True``.
• Fix awarii analizowania Python listy argumentów zawierających nawiasy w napisowych.
• regresji podczas tworzenia dokumentów Fix LaTeX z postaciami, które nie mają podpisów.
• Fix schematy dziedziczenia dla klas, które nie są picklable.
• Przedstaw osobny kolor tła dla przycisku paska bocznego upadku, dzięki czemu łatwiej zobaczyć.
• Fix drobnych błędów układu w kilku wbudowaną tematów.

Co nowego w wersji 1.0.2:

• Fix odsyłacze do obiektów typu dodanych przez: func:. `~ Funkcji .Sphinx.add_object_type` API
• obsługa Fix typów pól doc dla różnych typów dyrektywy.
• Zezwalaj łamanie długich podpisów, kontynuując luzie-uciekł nowej linii.
• Usuń niechciane stylizacji odnośników domen C (z powodu zderzenia ze stylami Pygments przestrzeni nazw).
• Możliwość odniesienia do PEP i RFC z wyraźnymi kotwic.
• LaTeX do odniesienia Fix figury.
• Podczas dokładne przeszukiwanie nie tylko mecze danego typu obiektu.
• Zastosuj bez dokładnego poszukiwania celów referencyjnych Pythona z `` .name`` dla modułów też.
• Crash Fix przy powielaniu parametr w polu listy informacji.
• Fix ustawienie domyślne rolę jednego dostarczone przez `` oldcmarkup`` rozszerzenia.
• Crash Fix gdy jest zainstalowany json-py, które zapewnia moduł json`` `` jest niezgodna się jednak simplejson.
• obsługa Fix celem nazewnictwa w intersphinx.
• usuwanie Fix ``! `` Dla wszystkich ról odsyłaczy.

Co nowego w wersji 1.0.1:

• Fix generowane nazwy obiektów domeny docelowe dla reszty; nie są one w tej samej przestrzeni nazw.
• Dodaj języka bengalskiego.
• Fix błąd podczas analizy nazwy obiektów JavaScript.
• Fix budynek z SingleHTMLBuilder gdy nie ma toctree.
• Wyświetlane nazwy Fix dla obiektów związanych z jawnymi przez intersphinx celów.
• Fix budynek z budowniczego JSON.
• hyperrefs Fix w opisach obiektów na lateks.

Co nowego w wersji 1.0:

• Ogólne:
• Dodano tryb "nitpicky", który emituje ostrzeżenia dla wszystkich brakujących odniesień. Jest on aktywowany przez: Opcja: `-n` przełącznika wiersza polecenia lub: confval:.` Nitpicky` wartości config
• Dodane `` latexpdf`` celem w QuickStart Makefile.
• Markup:
• : najpierw: Rola: `menuselection` i: najpierw: Rola:.` Guilabel` role teraz obsługuje Ampersand akceleratory
• Nowa składnia bardziej kompaktowy pola doc jest obecnie uznawane: ``: nazwa typu param. Description``
• Dodano opcję `` Karta-width``: RST: reż. `Literalinclude` dyrektywy
• Opcja `` dodane do titlesonly`` RST: reż:. `Dyrektywy toctree`
• Dodano i `` `` prepend`` opcje append`` do RST: reż:. `Literalinclude` dyrektywy
• Wszystko docinfo metadanych jest teraz umieścić w metadanych dokumentu, nie tylko autor.
• : najpierw: Rola: `ref` rolę może teraz odwołać tabel poprzez podpis
.
• : najpierw: reż. `Include` dyrektywy obsługuje ścieżki bezwzględne, które są interpretowane jako względem katalogu źródłowego
• W dziedzinie Python, odniesienia takie jak ``: `func. Teraz szukają .name``` pasujących nazw z dowolnym prefiksem, jeśli nie ma bezpośredniego zostanie znaleziony,
• Konfiguracja:
• Dodane: confval:. `Rst_prolog` wartość config
• Dodane: confval:. `Wartość html_secnumber_suffix` config kontrolować rozdział formatu numeracji
• Dodane: confval:. `Wartość html_compact_lists` config kontrolować kompaktowe listy docutils" wyposażone
• : confval: `html_sidebars` wartość config mogą teraz zawierać wzory jak klucze i wartości mogą być listami jawnie wybrać szablony, które należy zapewnić Sidebar. Oznacza to, że wbudowane bocznym może być zawartość zawiera tylko wybiórczo.
• : confval:. `Html_static_path` mogą teraz zawierać wpisy w jednym pliku
• Nowa uniwersalna wartość config: confval: `exclude_patterns` sprawia stary: confval:` unused_docs`,: confval: `exclude_trees` i: confval:.` Exclude_dirnames` nieaktualne
• Dodane: confval:. `Html_output_encoding` wartość config
• Dodano: confval wartość: `latex_docclass` i uczynił config" twoside "opcję DocumentClass przeciążać przez" oneside "
.
• Dodano: confval:. `Trim_doctest_flags` wartość config, który jest domyślnie wartość true
• Dodane: confval:. `Html_show_copyright` wartość config
• Dodane: confval: `latex_show_pagerefs` i: confval:.` Latex_show_urls` wartości config
• Zachowanie: confval: `html_file_suffix` nieznacznie zmienione: pusty ciąg znaków nie oznacza teraz" sufiks "zamiast" domyślnego przyrostka ", użycie` `None`` dla przyrostkiem" "default
.
• Nowe budowniczych:
• Dodane budowniczy w formacie EPUB.
• Dodane budowniczy strony podręcznika.
• Dodano pojedynczego pliku HTML budowniczy.
• Wyjście HTML:

Role
• Inline teraz uzyskać klasę CSS z podaniem ich nazwy, co pozwala dostosować styl ich wygląd. Role specyficzne dla domeny uzyskać dwie klasy, i `` `` domain`` domain-rolename``.
• Referencje teraz uzyskać klasę `` internal`` jeśli są wewnętrzne do całego projektu, w przeciwieństwie do wewnętrznych do aktualnej strony.
• Zewnętrzne odniesienia może być urządzone inaczej z nową opcją `` externalrefs`` tematu do domyślnego motywu.
• W domyślnego motywu, pasek boczny może teraz być eksperymentalnie składane za pomocą nowej opcji `` tematu collapsiblesidebar``.
• Toctrees są teraz pakowane w `` div`` tag z klasy `` toctree-wrapper`` w HTML.
• : Dane:. `Toctree` wymagalne w szablonach ma teraz argumentu` `maxdepth`` słowa kluczowego kontrolowania głębokości generowanego drzewa
• : Dane:. `Toctree` wymagalne w szablonach teraz przyjmuje argumentu` `titles_only`` słowa kluczowego
• Dodane `` Blok htmltitle`` w szablonie układu.
• W poszukiwaniu JavaScript, umożliwi wyszukanie nazw obiektów, w tym nazwę modułu, jak `` sys.argv``.
• Dodano nowy temat `` haiku`` inspirowany instrukcji obsługi Haiku OS.
• Dodano nowy temat `` nature``.
• Dodano nowy temat `` agogo``, stworzony przez Andi Albrecht.
• Dodano nowy temat `` scrolls``, stworzony przez Armin Ronacher.
• Dodano opcję `` tematu visitedlinkcolor`` do domyślnego motywu.
• Ulepszone reagowanie na stronie wyszukiwania poprzez załadowanie thesearch indeks asynchronicznie.
• Extension API:
• Dodane: Wydarzenie:. `Html-collect-pages`
• Dodane: confval: `needs_sphinx` config value i: met.` ~ Metoda sphinx.application.Sphinx.require_sphinx` aplikacji API
• Dodane: met. `~ Metoda sphinx.application.Sphinx.add_stylesheet` aplikacji API
• Rozszerzenia:
• Dodano: mod: `~ rozszerzenie sphinx.ext.viewcode`
.
• Dodano: mod: `~ rozszerzenie sphinx.ext.extlinks`
.
• Dodano wsparcie dla źródła zamawiania członków autodoktora z `` autodoc_member_order = "bysource'``.
• Dodane: confval:. `Autodoc_default_flags` wartość config, który może być używany, aby wybrać domyślne flagi dla wszystkich dyrektyw autodoktora
• Dodano drogę intersphinx nawiązać do wymienionych etykiet w innych projektach, a także określić projekt, który chcesz połączyć.
• autodoktora mogą udokumentować wystąpienie atrybuty przypisane w `` metod __init__``.
• Wiele usprawnień i poprawek do: mod:. `~ Rozszerzenia sphinx.ext.autosummary`, dzięki Pauli Virtanen
• : mod: `~ rozszerzenie sphinx.ext.graphviz` może teraz wyjście SVG zamiast obrazów PNG, kontrolowane przez confval:.` Graphviz_output_format` wartości config
• Opcja `` dodane do alt``: RST: reż:. `Dyrektyw rozszerzających graphviz`
• Dodane `` exclude`` argument: funk. `.autodoc.between`
• Tłumaczenia:
• Dodano tłumaczenie Chorwacki, dzięki Bojan Mihelac.
• Dodano tłumaczenie tureckiej, dzięki Firat Ozgul.
• Tłumaczenie Dodane kataloński, dzięki Pau Fernandez.
• Dodane uproszczone tłumaczenie na chiński.
• Dodano tłumaczenie duńskie, dzięki Hjorth Larsen.
• Dodano tłumaczenie litewskiej, dzięki Dalius Dobravolskas.

Co nowego w wersji 1.0b1:

• Wsparcie dla domen został dodany. Domena jest zbiorem dyrektyw i ról, które opisują obiekty należące razem, np elementy języka programowania. Kilka wbudowanych domen są: - Python - C - C ++ - JavaScript - reStructuredText
• stare znaczniki do określenia i link do dyrektyw C nie będą już działać bez aktywacji `` oldcmarkup`` rozszerzenia.
• Usunięto wsparcie dla starszych wersji zależności.
• Usunięto nieaktualne elementy.

Co nowego w wersji 0.6.5:

• W autodoktora, naprawić pominięcie niektórych członków wyraźnie udokumentowane za pomocą modułu komentarzy dokumentacji.
• kadrowanie Fix bocznego paska przewijania z `` stickysidebar`` opcji domyślnego motywu.
• Zawsze wygenerować nowe linie UNIX w Makefile szybkiego startu.
• Fix działa z `` -C`` pod Windows.
• W autodoktora, umożliwiają dostosowanie podpis obiekt, w którym wbudowany mechanizm zawodzi.
• Wyjście Fix dla wymienionych list z wartościami startowych w LaTeX-u.
• Dokonać rozruchu `` `` i after`` końcowego before`` opcje do `` literalinclude`` dyrektywy działać poprawnie, jeśli nie są używane razem.
• Fix generacji ogniwem w budowniczego LaTeX.

Co nowego w wersji 0.6.4:

• Poprawiono obsługę znaki inne niż Unicode w konfiguracji.
• OSErrors połowowe występujące podczas wywoływania graphviz z argumentami, że nie rozumie.
• Restore kompatybilność z Pygments & gt;. = 1.2
• Fix ucieczki od hyperref celów produkcji LaTeX.
• linki Fix generowane przez ``: doc. `` Roli wyjściu LaTeX
• Zdobądź todo węzły po cały dokument został odczytany; pozwala to na umieszczenie odniesienia zastępcze w todo elementów.
• Nie należy ignorować wyraźną wartość `` today`` budowy config w LaTeX.
• `` tekst alt`` schematów dziedziczenia jest teraz znacznie czystsze.
• Ignoruj ​​obrazy w tytułach sekcji podczas generowania podpisów linków.
• Wiadomości wyjątków Pomoc w blokach testoutput`` `` `` z rozszerzeniem doctest``.
• bloki liniowe są prawidłowo wyjścia w stylu HTML.
• ponownie Wykonane prace `` locale_dirs`` wartości config.
• `` wartości html_context`` podane w wierszu poleceń poprzez `` -A`` nie powinien pomniejszać inne wartości podane w conf.py.
• Fix bug uniemożliwia przyrostowych przebudowy dla `` dirhtml`` budowniczego.
• Fix maglowania cytatów w niektórych dosłownych bloków.
• Ścieżka Fix do indeksu wyszukiwania dla `` dirhtml`` budowniczego.
• Fix języka Jython zgodnością: sprawiają, że zależność od `` modułu parser`` opcjonalnym
.
• W autodoktora, złapać wszystkie błędy, które pojawiają się na module import, a nie tylko `` ImportError``.
• Fix obsługę brak danych, ale nie metoda deskryptory w autodoktora.
• Podczas kopiowania razy plików, zignoruj ​​OSErrors podniesionych przez `` os.utime () ``.

Wymagania :

• Pygments 1.2 lub wyższy,
• Jinja 2.3 lub wyższy,
• Docutils 0/7 lub wyższe