Sphinx

Что нового В этом выпуске:

• Добавить директивы удобство и роли в C ++ домене: директива `` CPP: var``, как псевдоним для `` CPP: member``, роль ``: CPP: var``, как псевдоним для ``: CPP: член ``, `и роль any` для кросс-ссылки на любой C ++ declaraction.
• Показать: confval: `Теперь source_suffix` значение конфигурации может быть список из нескольких суффиксов
.
• Добавить возможность указать источник анализаторы по источникам суффикса с: confval:. `source_parsers` значение конфигурации
• Новый строитель, AppleHelpBuilder, был добавлен, который строит справки Apple Книги.

Что нового в версии 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 Help отображение языка / кодировки для всех Сфинкса, поддерживаемые языки.

Что нового в версии 1.1:

• Особенности добавил:
• Добавлена ​​поддержка Python 3.x.
• Новые строители и подсистемы.
• Несовместимые изменения:
• Показать: первый: каталог `ру: module` директива не выводит его` `platform`` значение параметра больше. (Это было единственное, что директива сделал вывод, и, следовательно, вполне противоречивы.)
• Удалено поддержка версий старых иждивенцев.
• Новые Языки:
• Добавлена ​​Шведский языковой.
• Добавлена ​​Ирана местности.
• Добавлена ​​Латвии языковой.
• Добавлена ​​Непальский местности.
• Добавлена ​​корейской языковой.
• Добавлена ​​Эстонии местности.

Что нового в версии 1.0.8:

• Fix tracebacks для AttributeErrors в автореферата поколения.
• Закрепите `` abbr`` роль, когда аббревиатура имеет символы новой строки в нем.
• Fix ссылки на результаты с пользовательских типов объектов поиска.
• Исправлена ​​номера строки, приведенные в предупреждениями о неопределенных ссылках.
• Fix C ++ определения массива и аргументы шаблона, которые не вводите имена.
• Разрешить сноски в разделе заголовков в выходу LaTeX.
• Разрешить ключевые слова должны быть связаны с помощью intersphinx.
• Разрешить символы Unicode в список имен лексем производство.
• Добавить фиктивные посетителей за GraphViz узлов для текста и человека.
• Исправлена ​​файла изображения дублирование ошибка.
• Исправлена ​​разбор нескольких подписей в C ++ домена.
• Игнорировать файлы Emacs блокировки при поиске исходных файлов.
• Разрешить .pyw расширение для импортируемых модулей в AutoDoc.
• Использование `` $ (MAKE) `` в быстрого старта генерируемые make-файлов.
• Сделать боковой панели Ширина окно поиска последовательным в браузерах.
• Исправлена ​​расстояние центрированных фигур в выходе HTML.
• Безопасное кодирования сообщений SphinxError при печати их sys.stderr.
• Исправлена ​​ошибка LaTeX выход с документом без каких-либо разделов, но цель ссылка.
• Правильно лечить встроенный метод дескрипторов, как методы в AutoDoc.
• Остановить monkeypatching модуль Python TextWrap.
• Viewcode теперь работает правильно с исходными файлами, которые имеют кодировку ASCII без.
• Уважайте `` noindex`` вариант флага в ру:. директивам модуля
• Fix IndexErrors, когда в том числе несуществующих линий с: первого: каталог. `literalinclude`

Строки
• Уважение заказ функция / метод параметр сепаратор.
• Исправлена ​​несовместимость с JS Jquery & GT;. = 1,5
• Fix двойной кодировки сделано при написании HTMLHelp .hhk файлы.
• Не применять SmartyPants в разбираемых-буквенных блоков.
• C ++ домена теперь поддерживает определения массива.

Что нового в версии 1.0.6:

• Исправлена ​​трассировки в области Python для пустых перекрестных ссылок целей.
• Fix буквальные вопросы блок дисплея на Chrome браузеры.
• Поддержка сортировки ограниченный диапазон акцентированных символов в общем индексе и глоссарии.
• Попробуйте декодирования `` -D`` и `` аргументы -A`` командной строки с выбранной кодировке локали.
• Соблюдайте: confval:. `locale_dirs` при поиске переводы файле JS
• Добавить специальный код для лучшей поддержки японских документов в LaTeX строителя.
• Регресс # 77: Если есть только один параметр с ``: парам:. `` разметки, список пуля теперь подавлены снова
• Fix отсутствует абзаца на выходе LaTeX в определенных ситуациях.
• излучать `` событие AutoDoc-процесс-docstring`` даже для объектов без строку документации, так что он может добавить содержимое.
• в латексе застройщика, не только буквальные блоки требуют различной обработки таблицы, но также немало других список, как блочные элементы.
• Fix tracebacks в расширении viewcode для объектов Python, которые не имеют действительной подписи.
• Fix странные репортажи чисел строки для предупреждения, полученных от AutoDoc-включен строки документации, из-за различного поведения в зависимости от Docutils версии.
• Несколько исправлений к ++ домена C.

Что нового в версии 1.0.5:

• Добавить стилей CSS, необходимые для Docutils 0,7 выровненных изображений и фигур.
• В Makefile генерируется выходной LaTeX, не удаляйте файлы в формате PDF на чистый; они, возможно, потребуется изображения.
• Исправлена ​​LaTeX вывод, сгенерированный для линейных блоков.
• Разрешить `` .pyw`` как расширение исходного файла.

Что нового в версии 1.0.4:

• Открытые запасы intersphinx в двоичном режиме на ОС Windows, начиная с версии 2 содержит ZLIB-сжатых данных.
• Разрешить давая нелокальные URI, для файлов JavaScript, например, в расширении JSMath.
• Исправлена ​​трассировки, когда `` intersphinx_mapping`` пуст.

Что нового в версии 1.0.3:

• Fix Внутренний против внешнего различия ссылка на ссылкам Исходя из Docutils таблицы содержания диска.
• Закрепите `` maxdepth`` вариант для `` toctree () `` шаблон вызываемый при использовании `` развал = True``.
• Исправлена ​​аварии разбора аргументов Python списки, содержащие скобки в строковых литералов.
• Fix регрессии при строительстве LaTeX документы с цифрами, которые не имеют подписи.
• Fix схемы наследования для классов, которые пригодны для консервирования не.
• Представьте отдельный цвет фона для кнопки коллапса боковой панели, что делает его легче увидеть.
• Fix мелкие ошибки макета в нескольких встроенных тем.

Что нового в версии 1.0.2:

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

Что нового в версии 1.0.1:

• Fix сгенерированные имена целей для объектов доменных отдыха; они не находятся в том же пространстве имен.
• Добавить бенгальский язык.
• Исправлена ​​ошибка при разборе имен объектов JavaScript.
• Fix здание с SingleHTMLBuilder, когда нет toctree.
• Исправлена ​​имена дисплей для объектов, связанных с помощью intersphinx с явными целями.
• Fix строительства с застройщиком JSON.
• Fix hyperrefs в описаниях объектов для LaTeX.

Что нового в версии 1.0:

• Общие
• Добавлена ​​"nitpicky" режим, который испускает предупреждения для всех пропавших без вести ссылки. Она активируется опция: `: -n` параметром командной строки или: confval:.` Значение конфигурационного nitpicky`
• Добавлена ​​`` latexpdf`` цель в QuickStart Makefile.
• разметки:
• Показать: первый: роль: `menuselection` и: первый: роль:.` guilabel` роли теперь поддерживают амперсанда ускорители
• Новый синтаксис более компактное поле документ в настоящее время признается: ``: имя типа парам:. description``
• Добавлена ​​вкладка ``-width`` вариант: RST: каталог. `literalinclude` директива
• Добавлена ​​опция `` titlesonly`` на: первого: каталог. `директивы toctree`
• Добавлена ​​`` prepend`` и `` append`` варианты в: первого: каталог. `literalinclude` директивы
• Все DOCINFO метаданные уже вложил в метаданных документа, а не только автор.
• Показать: первый: роль: `ref` роль может теперь также справочные таблицы по надписи
.
• Показать: первый: каталог. `include` директива теперь поддерживает абсолютные пути, которые интерпретируются как по отношению к директории с исходным кодом
• В области Python, ссылки, как ``: FUNC: `. .name``` Теперь посмотрим на сопоставления имен с префиксом любого, если нет прямого соответствия не найдено
• Конфигурация:
• Добавлено: confval:. `rst_prolog` значение конфигурации
• Добавлено: confval:. `значение html_secnumber_suffix` конфигурации для управления раздел формат нумерации
• Добавлено: confval:. `значение html_compact_lists` конфигурации для управления компактными списки Docutils" оснащены
• Показать: 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:

Роли
• Встроенные теперь получить класс CSS с их именем, что позволяет настроить стили их внешний вид. Роли Предметно-ориентированные получить два класса `` domain`` и `` домена-rolename``.
• Литература теперь получить класс `` internal`` если они являются внутренними для всего проекта, в отличие от внутреннего к текущей странице.
• Внешние ссылки могут быть стилизованы по-разному с новой `` externalrefs`` опции тема для темы по умолчанию.
• В теме по умолчанию, на боковой панели можно экспериментально Теперь будут сборно-разборные с помощью нового `` collapsiblesidebar`` вариант тему.
• Toctrees сейчас завернутый в `` div`` тега с классом `` toctree-wrapper`` в выходе HTML.
• Показать: данные:. `toctree` выкупу в шаблонах теперь имеет` `maxdepth`` аргумент ключевое слово, чтобы контролировать глубину генерируемого дерева
• Показать: данные:. `toctree` выкупу в шаблонах сейчас принимает и` `titles_only`` аргумент ключевое слово
• Добавлена ​​`` htmltitle`` блок в шаблоне макета.
• В поисках JavaScript, позволяют ищете имен объектов, включая имя модуля, как `` sys.argv``.
• Добавлена ​​новая тема `` haiku``, вдохновленный руководстве пользователя Хайку OS.
• Добавлена ​​новая тема `` nature``.
• Добавлена ​​новая тема `` agogo``, созданный Энди Альбрехта.
• Добавлена ​​новая тема `` scrolls``, созданный Armin Ronacher.
• Добавлена ​​возможность `` тему visitedlinkcolor`` к теме по умолчанию.
• Улучшена отзывчивость на страницу поиска по загрузке thesearch индекс асинхронно.
• Расширение API:
• Добавлена: событие:. `HTML-собирать-pages`
• Добавлено: confval: `needs_sphinx` значение конфигурации и: мет:.` ~ метод API приложение sphinx.application.Sphinx.require_sphinx`
• Добавлено: мет:. `~ метод API приложение sphinx.application.Sphinx.add_stylesheet`
• Расширения:
• Добавлена: мод: `~ расширение sphinx.ext.viewcode`
.
• Добавлена: мод: `~ расширение sphinx.ext.extlinks`
.
• Добавлена ​​поддержка источника упорядочения членов AutoDoc, с `` autodoc_member_order = 'bysource'``.
• Добавлено: confval:. `autodoc_default_flags` значение конфигурации, которые могут быть использованы для выбора флаги по умолчанию для всех директив AutoDoc
• Добавлена ​​путь для intersphinx сослаться на названных марок в других проектах, и указать проект, который вы хотите сослаться.
• Autodoc теперь можно документировать экземпляр атрибутов, в `` __init__`` методов.
• Много улучшений и исправлений к: Mod.: `~ расширение sphinx.ext.autosummary`, благодаря Паули Виртанен
• Показать: мод: `~ расширение sphinx.ext.graphviz` теперь могут выхода SVG вместо изображений в формате PNG, контролируется confval:.` graphviz_output_format` значение конфигурации
• Добавлена ​​опция `` alt`` на: RST: каталог. `директив graphviz` расширения
• Добавлена ​​`` exclude`` аргумент: FUNC:. `.autodoc.between`
• Перевод:
• Добавлена ​​хорватской перевод, благодаря Боян Mihelac.
• Добавлена ​​перевод на турецкий язык, благодаря Фират Озгюль.
• перевод Добавлено каталанский, благодаря Pau Фернандес.
• Добавлена ​​упрощенный китайский перевод.
• Добавлена ​​датский перевод, благодаря Hjorth Ларсен.
• Добавлена ​​литовский перевод, благодаря Далюса Dobravolskas.

Что нового в версии 1.0b1:

• Поддержка для доменов была добавлена. Доменное представляет собой сборник директив и ролей, которые описывают все объекты, принадлежащие вместе, например, элементы языка программирования. Несколько доменов Встроенная команда предоставляются: - Python - С - C ++ - Java-script - ReStructuredText
• Старая разметки для определения и ссылки на C директив не будет работать без активации `` oldcmarkup`` расширение.
• Удалено поддержка версий старых иждивенцев.
• Удалены устаревшие элементы.

Что нового в версии 0.6.5:

• В AutoDoc, исправить упущение некоторых элементов модуля явно документально с помощью комментарии документации.
• Исправлена ​​обрезка боковой прокрутки с `` stickysidebar`` опции темы по умолчанию.
• Всегда генерировать UNIX новой строки в Makefile быстрого старта.
• Fix работает с `` -C`` под Windows.
• В AutoDoc, позволяют задать подпись объекта, где встроенный механизм дает сбой.
• Исправлена ​​выход для нумерованных списков с начала значений в LaTeX.
• Сделать `` пуск after`` и `` вариантов конечного before`` к `` literalinclude`` директивы работать правильно, если не используются вместе.
• поколение ссылку Fix в LaTeX строителя.

Что нового в версии 0.6.4:

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

Требования

• Pygments 1.2 или выше
• Дзиндзя 2.3 или выше
• Docutils 0/7 или выше