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`
• Розширення:
• Додана: Mod: `~ розширення sphinx.ext.viewcode`
.
• Додана: Mod: `~ розширення 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.
• Додана турецька переклад, завдяки Фірат Ozgul.
• переклад Додано каталанська, завдяки Pau Фернандес.
• Додана спрощена китайська переклад.
• Додана датський переклад, завдяки Hjorth Ларсен.
• Додана литовський переклад, завдяки Далюса Dobravolskas.

Що нового у версії 1.0b1:

• Підтримка для доменів була додана. Домен колекція директив і ролей, які описують всі об'єкти, що належать разом, наприклад, елементи мови програмування. Кілька доменів Вбудована команда надаються: - Python - С - C ++ - Javascript - 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 або вище