Опубликовано (http://librerussia.blogspot.ru/2014/12/sphinx.html) руководство по генераторатору документации Sphinx (http://sphinx-doc.org/). В руководстве (https://sphinx-ru.readthedocs.org/ru/latest/) подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs.

URL: http://librerussia.blogspot.ru/2014/12/sphinx.html
Новость: http://www.opennet.me/opennews/art.shtml?num=41364

• Руководство по генераторатору документации Sphinx ,Аноним, 11:42 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,анонисимус, 11:44 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 12:18 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 12:38 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,commiethebeastie, 13:05 , 30-Дек-14
    • Руководство по генераторатору документации Sphinx ,Аноним, 22:02 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 13:47 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 22:41 , 30-Дек-14
• Руководство по генераторатору документации Sphinx ,trdm, 13:11 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,бедный буратино, 13:46 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,myhand, 17:16 , 30-Дек-14
• Руководство по генераторатору документации Sphinx ,Парацельс, 14:27 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 15:30 , 30-Дек-14
    • Руководство по генераторатору документации Sphinx ,Парацельс, 16:11 , 30-Дек-14
      • Руководство по генераторатору документации Sphinx ,Аноним, 19:04 , 30-Дек-14
• Руководство по генераторатору документации Sphinx ,Rodegast, 14:40 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Вова, 16:05 , 30-Дек-14
• Руководство по генераторатору документации Sphinx ,Аноним, 15:25 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Парацельс, 16:10 , 30-Дек-14
    • Руководство по генераторатору документации Sphinx ,Вова, 18:41 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Вова, 16:21 , 30-Дек-14
  • Руководство по генераторатору документации Sphinx ,Аноним, 22:04 , 30-Дек-14
• Руководство по генератору документации Sphinx ,vitalif, 16:50 , 30-Дек-14
• Руководство по генератору документации Sphinx ,Аноним, 19:37 , 30-Дек-14
  • Руководство по генератору документации Sphinx ,Акроним, 11:03 , 31-Дек-14
  • Руководство по генератору документации Sphinx ,YetAnotherOnanym, 18:12 , 31-Дек-14
    • Руководство по генератору документации Sphinx ,myhand, 21:23 , 31-Дек-14

генераторатор?
что это?

Вот как это примерно: http://referats.yandex.ru/referats/

Doxygen нэ слищаль?

Это как генератор, только для бидонистов.

В шараге MS Word изучали?

Это называлось "Информатика"

Тулза для генераторации.

тебе, дегенератору, это не нужно

Это типа доскигена что-ли?
Или что-то другое?

это типа википедии чё-то.

открой любой док у 90% питоновских проектов - это и будет результат работы сфинкса. начиная от доков самого питона.

> Это типа доскигена что-ли?

В отличие от доксигена - исходный код документации могут еще и _люди_ читать.

http://sphinx-doc.org/

Офисные пакеты — это WYSIWYG («что видишь, то и получишь») редакторы, которые непосредственно работают с конечным форматом документа.

Генератор документации — генерирует конечный документ из другого формата. В Sphinx в качестве исходного формата используется обычный текстовый документ с разметкой reStructuredText.

reStructuredText - язык разметки (текста) в компьютерной терминологии — набор символов или последовательностей, вставляемых в текст для передачи информации о его выводе или строении.

Т.е. исходный документ выглядит примерно так:

Заголовок
=========

Какой то текст. *Курсив*, **Жирный**

Знаки равно указывают, что это заголовок, звездочки задают параметры начертания. Генератор документации преобразует эти символы и формирует конечный документ.

В этом заключается суть генераторов документации, грубо говоря.

Круто! Но вопрос-то был про генератораторы.

> Круто! Но вопрос-то был про генератораторы.

Тогда перечитайте ещё раз мой комментарий.

> Тогда перечитайте ещё раз мой комментарий.

А вы — мой. И, пожалуйста, во время чтения обращайте внимание не только на две первых и две последних буквы слов.

Почему нет PDF?

PDF есть.

Почему нет docx ?

Вообще-то есть.

Где??? Есть что-то кроме перечисленных в это ответе: https://stackoverflow.com/a/15388552 ?

> Почему нет docx ?

Потому что те три японских калеки, писавшие docx-builder для sphinx бросали дело на половине. Т.е. можно на bitbucket найти несколько репозиториев и их клонов, и это местами даже работает.
Но код там корявый (даже PEP8 не соблюдается) и неполный.

Вот сейчас сам страдаю как быть. Хочется доку перевести на sphinx, но нужно сохранить как вариант вывод в doc с корпоративным шаблоном. Дописывать японские поделия не хочется, т.к. например, для docx там внутрь впихнута библиотечка python-docx старой версии. А новой полностью поменяли API, да и не полная она ещё.
Пока решил сам написать билдер для odt, для него вроде более качественные бибилиотеки есть для python. А в docx потом конвертировать из odt.

Ненужно

asciidoc мне кажется поприкольней

Ещё один TeX?

Гораздо проще

Здесь нельзя признаваться в знании технологий, существовавших до рождения школоты. Видишь, уже первый минус получил.
Не буду его перебивать плюсом. Он у тебя будет как медаль, на самом деле.

> Не буду его перебивать плюсом.

Плюс и минус - совершенно эквивалентные награды от школоты.

А в принципе, в данном случае - совершенно правильный минус.  Нет, это не "еще один TeX", что как раз "не школоте" и должно быть самоочевидно.  (Впрочем, учитывая упоминание TeX, а не LaTeX - вангую знания о subj у минусуемого куда ниже плинтуса.  Если вы понимаете разницу - вам не надо это объяснять.  Если нет - вы ничем не лучше.)