Sphinx

Когато е създадена за първи път, това е основна цел е била да служи като генератор документация за Python лидер собствен код.
Оттогава проектът е достигнал култов статус в света на развитие, че е един от най-цитирани влияния в най-автоматични генератори документация около, независимо от езика.
Днес, освен само Python, Sphinx може да се използва с C и C ++ код, както и.

Какво ново в тази версия:

• Добави директиви удобство и роли на С ++ домейн: Директива `` CPP: var`` като псевдоним на `` CPP: member``, роля ``: CPP: var`` като псевдоним на ``: CPP: Държавите- `` и роля `any` за кръстосано позоваване на всеки C ++ declaraction.
• The: confval: `source_suffix` довереник стойност вече може да бъде списък от няколко наставки
.
• Добавяне на възможността да се определи източника парсери от източник наставка с: confval:. `Source_parsers` довереник стойност
• Нов строител, AppleHelpBuilder, е добавено, че строи Apple Помощ Books.

Какво ново във версия 1.2.3 / 1.3b3:

• Добавена `` sphinx.version_info`` кортеж за програмна проверка на Сфинкса версия.

Какво ново във версия 1.1.3:

• Фиксирана катастрофа с някои настройки на: confval:. `Modindex_common_prefix`
• Фиксирана боравене с `` -D`` и `` -A`` опции на Python 3.
• признати и предупреди за кръгови toctrees, вместо да вървят в грешки рекурсия.
• Възстанови съвместимост с docutils багажника.
• Фиксирани HtmlHelp запис от индекса линкове отново.
• Фиксирана inheritance_diagram повишаване грешки атрибутите на КЛАВИШНАта_ПОСЛЕДОВАТЕЛНОСТ.
• Фиксирани катастрофи когато слагате коментари или самотни термини в речник.
• Фиксирана HTML Помощ Език / кодиране картографиране за всички Sphinx поддържаните езици.

Какво ново във версия 1.1:

• Характеристики добавено:
• Добавено Python 3.x подкрепа.
• Нови строители и подсистемата.
• Несъвместими промени:
• The: RST: реж: `Ру: module` директива вече не прави продукцията си` `platform`` опция стойност. (Това беше единственото нещо, че директивата е направил изход, и затова доста непоследователна.)
• Премахната поддръжка на стари версии на зависимост.
• Нови части:
• Добавена Swedish локал.
• Добавена иранската локал.
• Добавена Латвийски локал.
• Добавена непалски локал.
• Добавена Korean локал.
• Добавена естонски локал.

Какво ново във версия 1.0.8:

• Fix tracebacks за AttributeErrors в autosummary поколение.
• Фиксирайте `` abbr`` роля при съкращението има нови редове в нея.
• Fix връзките към резултатите с потребителски типове обекти.
• Fix номерата на редовете, съобщени при предупреждения за неопределени препратки.
• Fix C ++ определения масив и аргументи шаблон, който не са тип имена.
• Разрешаване на бележки под линия в раздел заглавията в LaTeX изход.
• Разрешаване на ключови думи, за да бъде свързан чрез intersphinx.
• Разрешаване на Unicode символи в производствената листа символични имена.
• Добави фиктивни посетители за graphviz възли за текст и човек.
• Fix картинка дублиране бъг.
• Fix разбор на множество подписи в C ++ домейн.
• Игнорирай Emacs заключващи файлове, когато търсят изходни файлове.
• Позволи .pyw разширение за които се внасят модули в autodoc.
• Използвайте `` $ (марка) `` в QuickStart генерирано Makefile-ове.
• Направи страничната лента ширина на полето за търсене последователен в браузърите.
• Fix разстояние, по-центрирани фигури в HTML изход.
• Safely кодират SphinxError съобщения, когато отпечатването им да sys.stderr.
• Fix LaTeX изходна грешка с документ, без раздели, но мишена връзка.
• Правилно лечение вградени метод описания като методи в autodoc.
• Спри monkeypatching textwrap модула за Python.
• Viewcode сега работи правилно с изходни файлове, които имат не-ASCII кодиране.
• Уважавайте noindex`` опцията `` флаг в Ру:. Директиви модул
• Fix IndexErrors когато включително несъществуващ линии с: RST: реж. `Literalinclude`
• Зачитането на потребителски функции / метод параметър сепариращи струни.
• Fix JS несъвместимост с JQuery & GT;. = 1,5
• Fix двойно кодиране направено при писане HTMLHelp .hhk файлове.
• Не прилагайте SmartyPants в анализирани-буквални блокове.
• C ++ домейн вече поддържа определения масив.

Какво ново във версия 1.0.6:

• Fix traceback в Python домейн за празни препратки цели.
• Fix буквални въпроси дисплей блок на Chrome браузъри.
• Поддръжка за сортиране на ограничен набор от символи с ударения в общия индекс и речник.
• Опитайте декодиране `` -D`` и `` -A`` аргументи от командния ред с предпочитания от кодиране на локал.
• Спазвайте: confval:. `Locale_dirs` когато търсят преводи файл на JS
• Добавяне на специален код за по-добра поддръжка на японските документи в LaTeX строителя.
• Регресия на # 77: Ако има само един параметър се дава с ``: Парам:. `` Маркиране, списъка с куршум в момента потиснат отново
• Fix липсва параграф паузи в LaTeX изход в определени ситуации.
• излъчват `` autodoc-процес-docstring`` случай дори и за обекти без docstring, така че да могат да добавят съдържание.
• В LaTeX строител, не само буквални блокове изискват различна обработка на маса, но и доста други адреси, подобни блокови елементи.
• Fix tracebacks в разширението на viewcode за Python обекти, които не разполагат с валиден подпис.
• Fix странни reportings на номерата за предупреждения, получени от autodoc-включена docstrings, дължащи се на различно поведение в зависимост от docutils версия.
• Няколко поправки към ++ С домена.

Какво ново във версия 1.0.5:

• Добави стилове CSS, изисквани от docutils 0.7 за съответствие от изображения и фигури.
• В Makefile генерира от LaTeX изход, не изтривайте PDF файлове на чист; те може да се изисква изображения.
• Fix LaTeX изход генерира за линейни блокове.
• Позволи `` .pyw`` като разширение на файла източник.

Какво ново във версия 1.0.4:

• Open запаси intersphinx в двоичен режим на Windows, тъй като версия 2 съдържа данни ZLib-сгъстен.
• Позволи даване неместни URI адреси за джава файлове, напр в разширяването JSMath.
• Fix traceback когато `` intersphinx_mapping`` е празна.

Какво ново във версия 1.0.3:

• Fix вътрешния vs. външно отличие за връзки, идващи от docutils маса от употреба съдържанието на връзката.
• Фиксирайте maxdepth`` опцията `` за `` toctree () `` шаблон подлежащо на поискване изплащане, когато се използва с `` колапс = True``.
• Fix катастрофа разбор Python аргумент списъци, съдържащи скоби в символни низове.
• Fix регресия при изграждане на LaTeX документи с цифри, които не разполагат с надписи.
• Fix наследствата диаграми за класове, които не picklable.
• въвеждане на отделен цвят за фон на бутона на страничната лента колапс, което го прави по-лесно да се види.
• Fix малки оформление бъгове в няколко вградени теми.

Какво ново във версия 1.0.2:

• Fix препратки към обекти от типа добавено от: FUNC:. `~ Функция .Sphinx.add_object_type` API
• Fix боравене с видове полеви док за различни типове директива.
• Позволи счупи дълги подписи, което продължава с безлуфтови-избягал нови редове.
• Fix нежелан стайлинг на позовавания на домейни C (защото на пространство от имена сблъсък с стилове Pygments).
• Разрешаване на препратки към оживява и RFCs с изрично котви.
• Fix LaTeX препратки към фигури.
• Когато се прави не-точно търсене, мач само на даден тип обект.
• Apply не-точно търсене за референтни цели Python с `` .name`` за модули също.
• Fix катастрофата, когато дублира параметър в списъка инфо област.
• Fix определяне ролята на неизпълнение на едно предоставена от `` oldcmarkup`` разширяването.
• Fix катастрофата, когато е инсталиран JSON-Ру, който осигурява `` json`` модул, но е несъвместимо с simplejson.
• Fix обработка на целевата именуване в intersphinx.
• отстраняване Fix на ``! `` За всички препратки роли.

Какво ново във версия 1.0.1:

• Fix генерирани целеви имена за предмети останалата част на домейни; те не са в една и съща пространство от имена.
• Добавяне на бенгалски език.
• Fix бъг в разбор на JavaScript имена на обекти.
• Fix сграда с SingleHTMLBuilder когато няма toctree.
• екранни имена Fix за обекти, свързани с по intersphinx с изрични цели.
• Fix сграда с строителя JSON.
• Fix hyperrefs в описанията на обектите за латекс.

Какво ново във версия 1.0:

• General:
• Добавена на "nitpicky" режим, който излъчва предупреждения за всички липсващи препратки. Тя се активира от: опция: `-n` ключа от командния ред или на: confval:.` Nitpicky` довереник стойност
• Добавена `` latexpdf`` мишена в QuickStart Makefile.
• Markup:
• The: RST: Ролята: `menuselection` и: RST: роля:.
` guilabel` роли вече поддържат амперсанд ускорители
• New по-компактен поле док синтаксис сега се признава: ``: тип име Парам:. Description``
• Добавена `` таб-width`` опция за: RST: реж. `Literalinclude` директива
• Добавена `` опция titlesonly`` към: RST: реж. `Директива toctree`
• Добавена на `` prepend`` и `` append`` опции към: RST: реж. `Literalinclude` директива
• All docinfo метаданни сега е пусната в метаданните на документа, а не само на автора.
• The: RST: Ролята: `ref` роля сега също могат да референтни таблици с надпис
.
• The:
`include` директива вече поддържа абсолютни пътища, които се интерпретират като спрямо директорията източник: RST: реж.
• В областта Python, препратки като ``: функции:. `.name``` Сега търсят съвпадение имена с всеки префикс ако не се намери пряк двубой
• Configuration:
• Добавено: confval:. `Rst_prolog` довереник стойност
• Добавено: confval:. `Html_secnumber_suffix` довереник на стойност към управление на формата на номериране раздел
• Добавено: confval:. `Html_compact_lists` довереник стойност за контрол на компактни списъци docutils" разполагат
• The: confval: `html_sidebars` довереник стойност предприятието може да съдържа модели като ключове и стойности могат да бъдат списъци, които изрично да изберете кои следва да бъдат оказани на страничната лента шаблони. Това означава, че вградените съдържанието страничната лента може да бъде включен само избирателно.
• : confval:. `Сега html_static_path` може да съдържа единични записи файлови
• Новият универсален довереник стойност: confval: `exclude_patterns` прави стария: confval:` unused_docs`,: confval: `exclude_trees` и: confval:.` Exclude_dirnames` остарели
• Добавено: confval:. `Довереник стойност html_output_encoding`
• Добавена: confval: `latex_docclass` довереник стойност и е направил" twoside "documentclass опцията overridable от" oneside "
.
• Добавена: confval:. `Trim_doctest_flags` довереник стойност, което е вярно по подразбиране
• Добавено: confval:. `Довереник стойност html_show_copyright`
• Добавено: confval: `latex_show_pagerefs` и: confval:.` Latex_show_urls` стойности довереник
• Поведението на: confval: `html_file_suffix` леко променена: празен низ сега означава" не наставка "вместо" по подразбиране наставка ", ползване` `None`` за" неизпълнение наставка "
.
• Нови строители:
• Добавена строител за формата Epub.
• Добавена строител за ръчни страници.
• Добавена единичен файл HTML строител.
• HTML изход:
• Inline роли сега получават CSS клас с тяхното име, което позволява стилове, за да персонализирате външния си вид. Роли домейни специфични получават два класа, `` `` domain`` и домейн-rolename``.
• Позоваването сега получават класа `` internal`` ако те са вътрешни за целия проект, за разлика от вътрешния към текущата страница.
• Външни препратки може да бъде оформена по различен начин с новия externalrefs`` опцията `` тема за темата по подразбиране.
• В темата по подразбиране, от страничната лента, може експериментално сега да се направи сгъваем използвайки новата опция `` collapsiblesidebar`` тема.
• Toctrees сега са увити в `` div`` етикет с клас `` toctree-wrapper`` в HTML изход.
• The: данни:. `Toctree` изискуем в шаблони сега има` `maxdepth`` аргумент дума за контрол на дълбочината на генерирания дървото
• The: данни:. `Toctree` изискуем в шаблони сега приема` `titles_only`` аргумент дума
• Добавена `` htmltitle`` блок в оформление шаблон.
• В търсене на JavaScript, позволява да търсите имена на обекти, включително името на модула, като `` sys.argv``.
• Добавена е нова тема `` haiku``, вдъхновен от ръководството за потребителя на Haiku OS.
• Добавена е нова тема `` nature``.
• Добавена е нова тема `` agogo``, създадена от Andi Албрехт.
• Добавена е нова тема `` scrolls``, създадена от Armin Ronacher.
• Добавена тема опция `` visitedlinkcolor`` да темата по подразбиране.
• Подобряване на ответната реакция на страницата за търсене чрез зареждане thesearch индекс асинхронно.
• Extension API:
• Добавена: събитие:. `HTML-Collect-pages`
• Добавено: confval: `needs_sphinx` стойност довереник и: мет:.` ~ Метод sphinx.application.Sphinx.require_sphinx` заявление API
• Добавено: мет:. `~ Метод sphinx.application.Sphinx.add_stylesheet` заявление API
• Extensions:
• Добавена на: Министерството на отбраната: `~ разширение sphinx.ext.viewcode`
.
• Добавена на: Министерството на отбраната: `~ разширение sphinx.ext.extlinks`
.
• Добавена е поддръжка за източник поръчване на членовете във autodoc, с `` autodoc_member_order = 'bysource'``.
• Добавено: confval:. `Autodoc_default_flags` стойност довереник, който може да се използва, за да изберете по подразбиране знамена за всички директиви autodoc
• Добавена начин за intersphinx да се позове на именувани етикети и в други проекти, както и да се уточни на проекта, който искате да се свържете с
.
• Autodoc сега може да документира например признака, присвоени в `` __init__`` методи.
• Много подобрения и поправки на: Министерството на отбраната:. `~ Разширението sphinx.ext.autosummary`, благодарение на Pauli Виртанен
• The: мод: `~ разширение sphinx.ext.graphviz` вече могат изход SVG вместо PNG изображения, контролирана от confval:.` Graphviz_output_format` довереник стойност
• Добавена `` опция alt`` към: RST: реж. `Директиви graphviz` разширение
• Добавена `` exclude`` аргумент за: функции:. `.autodoc.between`
• Преводи:
• Добавена хърватски превод, благодарение на Боян Mihelac.
• Добавена турски превод, благодарение на Фират Ozgul.
• Добавено каталонски превод, благодарение на Пау Фернандес.
• Добавена опростен китайски превод.
• Добавена датския превод, благодарение на Хьорт Larsen.
• Добавена Литовски превод, благодарение на Dalius Dobravolskas.

Какво ново във версия 1.0b1:

• Подкрепа за домейни е добавена. Домейнът е колекция от директиви и роли, които всички описват предмети, принадлежащи заедно, напр елементи на един език за програмиране. Осигурени са няколко вградените домейни: - Python - C - C ++ - JavaScript - reStructuredText
• Старата маркиране за определянето и свързването с директиви C няма да работи повече, без активиране на `` oldcmarkup`` разширяването.
• Премахната поддръжка на стари версии на зависимост.
• Премахнати отхвърлени елементи.

Какво ново във версия 0.6.5:

• В autodoc, определи със заличаването на някои членове модул изрично документирано използване на коментари документация.
• Fix изрязване на страничната лента за превъртане бар с `` stickysidebar`` вариант на темата по подразбиране.
• Винаги генерира UNIX нови редове в QuickStart Makefile.
• Fix работи с `` -C`` под Windows.
• В autodoc, позволяват персонализиране на подписа на един обект, където вграден механизъм не успее.
• Fix изход за изброените списъци с начални стойности в LaTeX.
• Направете `` начало-after`` и `` опции краен before`` до `` literalinclude`` директива работят правилно, ако не се използват заедно.
• Fix поколение линк в LaTeX строителя.

Какво ново във версия 0.6.4:

• Подобрена обработка на низове не-Unicode в конфигурацията.
• улова OSErrors настъпили, когато се обаждате graphviz с аргументи, че не разбира.
• Възстанови съвместимост с Pygments & GT;. = 1.2
• Fix бягство от hyperref цели в LaTeX изход.
• Fix връзки, генерирани от ``: док. `` Роля за LaTeX изход
• Събирайте Todo възли след целия документ е прочетено; това позволява поставяне на заместване препратки в Todo елементи.
• Не пренебрегвайте изрично `` довереник стойност today`` в LaTeX строителство.
• The `` alt`` текста на наследството диаграми вече е много по-чист.
• Игнорирай снимки в раздел заглавия, когато се генерира линк надписи.
• Поддръжка изключение на съобщения в `` testoutput`` блоковете на `` разширението doctest``.
• Line блокове са оформена правилно в HTML изход.
• Създадено за `` locale_dirs`` довереник стойност работа отново.
• `` html_context`` стойности, дадени в командния ред чрез `` -A`` не трябва да замени други стойности, дадени в conf.py.
• Fix бъг предотвратяване точкови възстановява за `` dirhtml`` строителя.
• Fix обезобразяването на котировки в някои буквални блокове.
• Fix път към индекса за търсене на `` dirhtml`` строителя.
• Fix въпрос Jython съвместимост: да зависимостта от `` parser`` модул по избор
.
• В autodoc, улов на всички грешки, които се случват на модул за внос, а не само `` ImportError``.
• Fix манипулирането на не-данни, но не-метод описания в autodoc.
• При копиране на файлове пъти, игнорира OSErrors повдигнати от `` os.utime () ``.

<силни> Изисквания

• Pygments 1.2 или по-висока
• Джинджа 2.3 или по-висока
• Docutils 0/7 или по-високи