forum.opennet.ru - "Руководство по генераторатору документации Sphinx " (27)

форумы

помощь

поиск

регистрация

майллист

вход/выход

слежка

"Руководство по генераторатору документации Sphinx "

Форум Разговоры, обсуждение новостей
Вариант для распечатки		Пред. тема \| След. тема
Изначальное сообщение		[ Отслеживать ]

"Руководство по генераторатору документации Sphinx "	+/–
Сообщение от opennews (??) on 30-Дек-14, 11:42
Опубликовано (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
Ответить \| Правка \| Cообщить модератору

Оглавление

Руководство по генераторатору документации Sphinx , Аноним, 11:42 , 30-Дек-14, (1) –1

Руководство по генераторатору документации Sphinx , анонисимус, 11:44 , 30-Дек-14, (2) –3
Руководство по генераторатору документации Sphinx , Аноним, 12:18 , 30-Дек-14, (3) –3
Руководство по генераторатору документации Sphinx , Аноним, 12:38 , 30-Дек-14, (4) +2
Руководство по генераторатору документации Sphinx , commiethebeastie, 13:05 , 30-Дек-14, (6)

Руководство по генераторатору документации Sphinx , Аноним, 22:02 , 30-Дек-14, (23)

Руководство по генераторатору документации Sphinx , Аноним, 13:47 , 30-Дек-14, (9) +2
Руководство по генераторатору документации Sphinx , Аноним, 22:41 , 30-Дек-14, (25)

Руководство по генераторатору документации Sphinx , trdm, 13:11 , 30-Дек-14, (7)

Руководство по генераторатору документации Sphinx , бедный буратино, 13:46 , 30-Дек-14, (8) +1
Руководство по генераторатору документации Sphinx , myhand, 17:16 , 30-Дек-14, (19)

Руководство по генераторатору документации Sphinx , Парацельс, 14:27 , 30-Дек-14, (10) +2

Руководство по генераторатору документации Sphinx , Аноним, 15:30 , 30-Дек-14, (13) +1

Руководство по генераторатору документации Sphinx , Парацельс, 16:11 , 30-Дек-14, (16) –1

Руководство по генераторатору документации Sphinx , Аноним, 19:04 , 30-Дек-14, (21) +2

Руководство по генераторатору документации Sphinx , Rodegast, 14:40 , 30-Дек-14, (11) –1

Руководство по генераторатору документации Sphinx , Вова, 16:05 , 30-Дек-14, (14)

Руководство по генераторатору документации Sphinx , Аноним, 15:25 , 30-Дек-14, (12) –5

Руководство по генераторатору документации Sphinx , Парацельс, 16:10 , 30-Дек-14, (15) +1

Руководство по генераторатору документации Sphinx , Вова, 18:41 , 30-Дек-14, (20)

Руководство по генераторатору документации Sphinx , Вова, 16:21 , 30-Дек-14, (17)
Руководство по генераторатору документации Sphinx , Аноним, 22:04 , 30-Дек-14, (24)

Руководство по генератору документации Sphinx , vitalif, 16:50 , 30-Дек-14, (18) +1
Руководство по генератору документации Sphinx , Аноним, 19:37 , 30-Дек-14, (22) –1

Руководство по генератору документации Sphinx , Акроним, 11:03 , 31-Дек-14, (26)
Руководство по генератору документации Sphinx , YetAnotherOnanym, 18:12 , 31-Дек-14, (27)

Руководство по генератору документации Sphinx , myhand, 21:23 , 31-Дек-14, (28)

Сообщения по теме [Сортировка по времени | RSS]

1. "Руководство по генераторатору документации Sphinx " –1 +/–

Сообщение от Аноним (??) on 30-Дек-14, 11:42

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

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

2. "Руководство по генераторатору документации Sphinx " –3 +/–

Сообщение от анонисимус on 30-Дек-14, 11:44

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

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

3. "Руководство по генераторатору документации Sphinx " –3 +/–

Сообщение от Аноним (??) on 30-Дек-14, 12:18

Doxygen нэ слищаль?

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

4. "Руководство по генераторатору документации Sphinx " +2 +/–

Сообщение от Аноним (??) on 30-Дек-14, 12:38

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

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

6. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от commiethebeastie (ok) on 30-Дек-14, 13:05

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

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

23. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Аноним (??) on 30-Дек-14, 22:02

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

Ответить | Правка | ^ к родителю #6 | Наверх | Cообщить модератору

9. "Руководство по генераторатору документации Sphinx " +2 +/–

Сообщение от Аноним (??) on 30-Дек-14, 13:47

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

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

25. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Аноним (??) on 30-Дек-14, 22:41

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

Ответить | Правка | ^ к родителю #1 | Наверх | Cообщить модератору

7. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от trdm (ok) on 30-Дек-14, 13:11

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

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

8. "Руководство по генераторатору документации Sphinx " +1 +/–

Сообщение от бедный буратино (ok) on 30-Дек-14, 13:46

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

Ответить | Правка | ^ к родителю #7 | Наверх | Cообщить модератору

19. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от myhand (ok) on 30-Дек-14, 17:16

> Это типа доскигена что-ли?
В отличие от доксигена - исходный код документации могут еще и _люди_ читать.
http://sphinx-doc.org/

Ответить | Правка | ^ к родителю #7 | Наверх | Cообщить модератору

10. "Руководство по генераторатору документации Sphinx " +2 +/–

Сообщение от Парацельс on 30-Дек-14, 14:27

Офисные пакеты — это WYSIWYG («что видишь, то и получишь») редакторы, которые непосредственно работают с конечным форматом документа.
Генератор документации — генерирует конечный документ из другого формата. В Sphinx в качестве исходного формата используется обычный текстовый документ с разметкой reStructuredText.
reStructuredText - язык разметки (текста) в компьютерной терминологии — набор символов или последовательностей, вставляемых в текст для передачи информации о его выводе или строении.
Т.е. исходный документ выглядит примерно так:
Заголовок
=========
Какой то текст. *Курсив*, **Жирный**

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

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

13. "Руководство по генераторатору документации Sphinx " +1 +/–

Сообщение от Аноним (??) on 30-Дек-14, 15:30

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

Ответить | Правка | ^ к родителю #10 | Наверх | Cообщить модератору

16. "Руководство по генераторатору документации Sphinx " –1 +/–

Сообщение от Парацельс on 30-Дек-14, 16:11

> Круто! Но вопрос-то был про генератораторы.
Тогда перечитайте ещё раз мой комментарий.

Ответить | Правка | ^ к родителю #13 | Наверх | Cообщить модератору

21. "Руководство по генераторатору документации Sphinx " +2 +/–

Сообщение от Аноним (??) on 30-Дек-14, 19:04

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

Ответить | Правка | ^ к родителю #16 | Наверх | Cообщить модератору

11. "Руководство по генераторатору документации Sphinx " –1 +/–

Сообщение от Rodegast (ok) on 30-Дек-14, 14:40

Почему нет PDF?

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

14. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Вова on 30-Дек-14, 16:05

PDF есть.

Ответить | Правка | ^ к родителю #11 | Наверх | Cообщить модератору

12. "Руководство по генераторатору документации Sphinx " –5 +/–

Сообщение от Аноним (??) on 30-Дек-14, 15:25

Почему нет docx ?

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

15. "Руководство по генераторатору документации Sphinx " +1 +/–

Сообщение от Парацельс on 30-Дек-14, 16:10

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

Ответить | Правка | ^ к родителю #12 | Наверх | Cообщить модератору

20. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Вова on 30-Дек-14, 18:41

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

Ответить | Правка | ^ к родителю #15 | Наверх | Cообщить модератору

17. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Вова on 30-Дек-14, 16:21

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

Ответить | Правка | ^ к родителю #12 | Наверх | Cообщить модератору

24. "Руководство по генераторатору документации Sphinx " +/–

Сообщение от Аноним (??) on 30-Дек-14, 22:04

Ненужно

Ответить | Правка | ^ к родителю #12 | Наверх | Cообщить модератору

18. "Руководство по генератору документации Sphinx " +1 +/–

Сообщение от vitalif (ok) on 30-Дек-14, 16:50

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

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

22. "Руководство по генератору документации Sphinx " –1 +/–

Сообщение от Аноним (??) on 30-Дек-14, 19:37

Ещё один TeX?

Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

26. "Руководство по генератору документации Sphinx " +/–

Сообщение от Акроним on 31-Дек-14, 11:03

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

Ответить | Правка | ^ к родителю #22 | Наверх | Cообщить модератору

27. "Руководство по генератору документации Sphinx " +/–

Сообщение от YetAnotherOnanym (ok) on 31-Дек-14, 18:12

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

Ответить | Правка | ^ к родителю #22 | Наверх | Cообщить модератору

28. "Руководство по генератору документации Sphinx " +/–

Сообщение от myhand (ok) on 31-Дек-14, 21:23

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

Ответить | Правка | ^ к родителю #27 | Наверх | Cообщить модератору

Архив | Удалить

Рекомендовать для помещения в FAQ | Индекс форумов | Темы | Пред. тема | След. тема

Партнёры:

Хостинг:

Закладки на сайте
Проследить за страницей

Created 1996-2024 by Maxim Chirkov
Добавить, Поддержать, Вебмастеру

1. "Руководство по генераторатору документации Sphinx "	–1 +/–
Сообщение от Аноним (??) on 30-Дек-14, 11:42
генераторатор? что это?
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	2. "Руководство по генераторатору документации Sphinx "	–3 +/–
	Сообщение от анонисимус on 30-Дек-14, 11:44
	Вот как это примерно: http://referats.yandex.ru/referats/
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору


	3. "Руководство по генераторатору документации Sphinx "	–3 +/–
	Сообщение от Аноним (??) on 30-Дек-14, 12:18
	Doxygen нэ слищаль?
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору


	4. "Руководство по генераторатору документации Sphinx "	+2 +/–
	Сообщение от Аноним (??) on 30-Дек-14, 12:38
	Это как генератор, только для бидонистов.
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору


	6. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от commiethebeastie (ok) on 30-Дек-14, 13:05
	В шараге MS Word изучали?
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору


	23. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Аноним (??) on 30-Дек-14, 22:02
	Это называлось "Информатика"
	Ответить \| Правка \| ^ к родителю #6 \| Наверх \| Cообщить модератору


	9. "Руководство по генераторатору документации Sphinx "	+2 +/–
	Сообщение от Аноним (??) on 30-Дек-14, 13:47
	Тулза для генераторации.
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору


	25. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Аноним (??) on 30-Дек-14, 22:41
	тебе, дегенератору, это не нужно
	Ответить \| Правка \| ^ к родителю #1 \| Наверх \| Cообщить модератору

7. "Руководство по генераторатору документации Sphinx "	+/–
Сообщение от trdm (ok) on 30-Дек-14, 13:11
Это типа доскигена что-ли? Или что-то другое?
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	8. "Руководство по генераторатору документации Sphinx "	+1 +/–
	Сообщение от бедный буратино (ok) on 30-Дек-14, 13:46
	это типа википедии чё-то. открой любой док у 90% питоновских проектов - это и будет результат работы сфинкса. начиная от доков самого питона.
	Ответить \| Правка \| ^ к родителю #7 \| Наверх \| Cообщить модератору


	19. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от myhand (ok) on 30-Дек-14, 17:16
	> Это типа доскигена что-ли? В отличие от доксигена - исходный код документации могут еще и _люди_ читать. http://sphinx-doc.org/
	Ответить \| Правка \| ^ к родителю #7 \| Наверх \| Cообщить модератору

10. "Руководство по генераторатору документации Sphinx "	+2 +/–
Сообщение от Парацельс on 30-Дек-14, 14:27
Офисные пакеты — это WYSIWYG («что видишь, то и получишь») редакторы, которые непосредственно работают с конечным форматом документа. Генератор документации — генерирует конечный документ из другого формата. В Sphinx в качестве исходного формата используется обычный текстовый документ с разметкой reStructuredText. reStructuredText - язык разметки (текста) в компьютерной терминологии — набор символов или последовательностей, вставляемых в текст для передачи информации о его выводе или строении. Т.е. исходный документ выглядит примерно так: Заголовок ========= Какой то текст. Курсив, Жирный Знаки равно указывают, что это заголовок, звездочки задают параметры начертания. Генератор документации преобразует эти символы и формирует конечный документ. В этом заключается суть генераторов документации, грубо говоря.
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	13. "Руководство по генераторатору документации Sphinx "	+1 +/–
	Сообщение от Аноним (??) on 30-Дек-14, 15:30
	Круто! Но вопрос-то был про генератораторы.
	Ответить \| Правка \| ^ к родителю #10 \| Наверх \| Cообщить модератору


	16. "Руководство по генераторатору документации Sphinx "	–1 +/–
	Сообщение от Парацельс on 30-Дек-14, 16:11
	> Круто! Но вопрос-то был про генератораторы. Тогда перечитайте ещё раз мой комментарий.
	Ответить \| Правка \| ^ к родителю #13 \| Наверх \| Cообщить модератору


	21. "Руководство по генераторатору документации Sphinx "	+2 +/–
	Сообщение от Аноним (??) on 30-Дек-14, 19:04
	> Тогда перечитайте ещё раз мой комментарий. А вы — мой. И, пожалуйста, во время чтения обращайте внимание не только на две первых и две последних буквы слов.
	Ответить \| Правка \| ^ к родителю #16 \| Наверх \| Cообщить модератору

11. "Руководство по генераторатору документации Sphinx "	–1 +/–
Сообщение от Rodegast (ok) on 30-Дек-14, 14:40
Почему нет PDF?
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	14. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Вова on 30-Дек-14, 16:05
	PDF есть.
	Ответить \| Правка \| ^ к родителю #11 \| Наверх \| Cообщить модератору

12. "Руководство по генераторатору документации Sphinx "	–5 +/–
Сообщение от Аноним (??) on 30-Дек-14, 15:25
Почему нет docx ?
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	15. "Руководство по генераторатору документации Sphinx "	+1 +/–
	Сообщение от Парацельс on 30-Дек-14, 16:10
	Вообще-то есть.
	Ответить \| Правка \| ^ к родителю #12 \| Наверх \| Cообщить модератору


	20. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Вова on 30-Дек-14, 18:41
	Где??? Есть что-то кроме перечисленных в это ответе: https://stackoverflow.com/a/15388552 ?
	Ответить \| Правка \| ^ к родителю #15 \| Наверх \| Cообщить модератору


	17. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Вова on 30-Дек-14, 16:21
	> Почему нет docx ? Потому что те три японских калеки, писавшие docx-builder для sphinx бросали дело на половине. Т.е. можно на bitbucket найти несколько репозиториев и их клонов, и это местами даже работает. Но код там корявый (даже PEP8 не соблюдается) и неполный. Вот сейчас сам страдаю как быть. Хочется доку перевести на sphinx, но нужно сохранить как вариант вывод в doc с корпоративным шаблоном. Дописывать японские поделия не хочется, т.к. например, для docx там внутрь впихнута библиотечка python-docx старой версии. А новой полностью поменяли API, да и не полная она ещё. Пока решил сам написать билдер для odt, для него вроде более качественные бибилиотеки есть для python. А в docx потом конвертировать из odt.
	Ответить \| Правка \| ^ к родителю #12 \| Наверх \| Cообщить модератору


	24. "Руководство по генераторатору документации Sphinx "	+/–
	Сообщение от Аноним (??) on 30-Дек-14, 22:04
	Ненужно
	Ответить \| Правка \| ^ к родителю #12 \| Наверх \| Cообщить модератору

18. "Руководство по генератору документации Sphinx "	+1 +/–
Сообщение от vitalif (ok) on 30-Дек-14, 16:50
asciidoc мне кажется поприкольней
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору

22. "Руководство по генератору документации Sphinx "	–1 +/–
Сообщение от Аноним (??) on 30-Дек-14, 19:37
Ещё один TeX?
Ответить \| Правка \| ^ к родителю #0 \| Наверх \| Cообщить модератору


	26. "Руководство по генератору документации Sphinx "	+/–
	Сообщение от Акроним on 31-Дек-14, 11:03
	Гораздо проще
	Ответить \| Правка \| ^ к родителю #22 \| Наверх \| Cообщить модератору


	27. "Руководство по генератору документации Sphinx "	+/–
	Сообщение от YetAnotherOnanym (ok) on 31-Дек-14, 18:12
	Здесь нельзя признаваться в знании технологий, существовавших до рождения школоты. Видишь, уже первый минус получил. Не буду его перебивать плюсом. Он у тебя будет как медаль, на самом деле.
	Ответить \| Правка \| ^ к родителю #22 \| Наверх \| Cообщить модератору


	28. "Руководство по генератору документации Sphinx "	+/–
	Сообщение от myhand (ok) on 31-Дек-14, 21:23
	> Не буду его перебивать плюсом. Плюс и минус - совершенно эквивалентные награды от школоты. А в принципе, в данном случае - совершенно правильный минус. Нет, это не "еще один TeX", что как раз "не школоте" и должно быть самоочевидно. (Впрочем, учитывая упоминание TeX, а не LaTeX - вангую знания о subj у минусуемого куда ниже плинтуса. Если вы понимаете разницу - вам не надо это объяснять. Если нет - вы ничем не лучше.)
	Ответить \| Правка \| ^ к родителю #27 \| Наверх \| Cообщить модератору