URL: https://www.opennet.me/cgi-bin/openforum/vsluhboard.cgi
Форум: vsluhforumID3
Нить номер: 109511
[ Назад ]
Исходное сообщение
"Опубликован отформатированный вариант документации к ядру Linux"
Отправлено opennews , 29-Окт-16 11:26 
На kernel.org появился (https://kernel.org/doc/html/latest/) новый раздел с документацией к ядру Linux, для создания которого использован пакет Sphinx (http://www.sphinx-doc.org/). В отличие от ранее предлагаемого набора текстовых файлов, новая документация благодаря добавлению в текст разметки reStructuredText (https://ru.wikipedia.org/wiki/ReStructuredText) (RST), переведена в гипертекстовое представление и отформатирована для удобного чтения. Также сообщается (https://blogs.s-osg.org/documenting-linux-kernel-development... о переводе на  Sphinx ряда документов (https://mchehab.fedorapeople.org/kernel_docs/) для разработчиков ядра, рассказывающих об особенностях процесса разработки и организации работы в сообществе.


URL: http://lwn.net/Articles/704942/rss
Новость: http://www.opennet.me/opennews/art.shtml?num=45393

Содержание
Сообщения в этом обсуждении
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 29-Окт-16 11:26 
Прекрасно
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено ArchUser , 29-Окт-16 11:41 
Что лучше: MarkDown (md) или reStructuredText (RST)?
Думаю, в чем самому писать для проекта.
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено freehck , 29-Окт-16 11:59 
Не велика разница. Есть публикаторы, которые позволяют просмотреть эти файлики в любом удобном виде.

Для себя же пользую Org, потому что его одинакого удобно читать что в браузере, что в редакторе.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 29-Окт-16 14:37 
md сравнительно более примитивный, поэтому его почти никто и не использует для документации.

Даже на этом вашем гитхабчике, где на md разные статьи, тексты и посты...

> Для себя же пользую Org

А в чем приемущества, vs md в читабельности?  Мне казалось, это тоже очень специальный текстовый формат + заточенный под специфические задачи.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено QuAzI , 29-Окт-16 14:53 
В чём он более примитивный? Что такого в RST есть, чего нет в md?
И дайте линк на статистику, что чаще используют =)
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено irinat , 29-Окт-16 16:57 
> Что такого в RST есть, чего нет в md?

Единая спецификация.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено KonstantinB , 29-Окт-16 23:27 
В классическом markdown Грубера нет даже таблиц.

Существует множество расширений markdown, де-факто гитхабовский вариант самый популярный, но единой спецификации до сих пор никто не сделал.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено anonymous , 03-Ноя-16 05:27 
> единой спецификации до сих пор никто не сделал.

http://commonmark.org/

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 03-Ноя-16 11:21 
>> единой спецификации до сих пор никто не сделал.
> http://commonmark.org/

AFAIK, даже гитхабчик ей не следует.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 30-Окт-16 14:26 
> В чём он более примитивный? Что такого в RST есть, чего нет в md?

http://zverovich.net/2016/06/16/rst-vs-markdown.html

> И дайте линк на статистику, что чаще используют =)

Ок, будем считать что это было субъективное утверждение.  Просто я не знаю ни одного проекта, что использует md, в отличие от десятков на sphinx-doc.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено freehck , 31-Окт-16 12:07 
>> Для себя же пользую Org
> А в чем приемущества, vs md в читабельности?  Мне казалось, это
> тоже очень специальный текстовый формат + заточенный под специфические задачи.

В читабельности между вышеописанными форматами разницы нет. Разница заключается в редактировании. Org-mode - это нехилый комбайн, который может значительно больше, нежели просто форматирование текста.

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

В дополнение к стандартной части в виде табличек, параграфов, ссылок и т.п. вышеперечисленные - это очень круто.

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 02-Ноя-16 21:48 
> Org-mode - это нехилый комбайн, который может значительно больше, нежели просто
> форматирование текста.

Ах, это.  Нет, тут я понимаю, просто подумал речь шла о каких-то приемуществах форматирования.


"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Чаёвник , 29-Окт-16 12:33 
Markdown на хабре, на гитхабе, битбакете и гитлабе, в каком-то мессенджере частичная поддержка была, редакторов троху есть даже мобильных. А про этот формат ни соуху ни духу. И да, md читаем даже как plain text
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 29-Окт-16 14:30 
В тайге с медведями живешь?
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 30-Окт-16 21:17 
Нужда в спецсофте - жирный минус. Особенно для документации, что ни говори.
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено myhand , 02-Ноя-16 21:56 
> Нужда в спецсофте - жирный минус.

Еще один любитель читать LaTeX на ночь?

> Особенно для документации, что ни говори.

Документация - вообще штука сложная.  Перекрестные ссылки, параметры/аргументы/аттрибуты функций/методов/классов, примеры, уже помянутая к ночи математика.  Просто посмотрите numpydoc, в качестве примера того что людям на практике нада.

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

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 29-Окт-16 15:23 
> Markdown на хабре, на гитхабе, битбакете и гитлабе, в каком-то мессенджере частичная поддержка была, редакторов троху есть даже мобильных.

... и на СоурцФорже
https://sourceforge.net/p/forge/documentation/markdown_syntax/

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено QuAzI , 29-Окт-16 13:16 
Весьма радует в md возможность встраивать исходные коды с подсветкой синтаксиса и блоксхемы, например так https://github.com/weijiaming/QtCreator-Markdown-Editor-Plugin
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Andrey Mitrofanov , 29-Окт-16 19:46 
> Весьма радует в md возможность встраивать исходные коды с подсветкой синтаксиса и
> блоксхемы, например так https://github.com/weijiaming/QtCreator-Markdown-Editor-Plugin

Чего только не придумают, лишь бы Org mode не пользовать. И с кодами https://github.com/dvvc/org-python , и с https://github.com/dfeich/org-screenshot картинками, и на гитхабиках https://github.com/oscarperpinan/meteoForecast , и...  диаграм http://home.fnal.gov/~neilsen/notebook/orgExamples/org-examp... на гитхабе не нашёл.  https://xkcd.com/518/

"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено QuAzI , 30-Окт-16 13:42 
Фичи впечатляют. Но исходники всё-таки хуже читаемы (особенно когда видишь это первый раз как plain text и хз про особенности разметки)
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено user , 29-Окт-16 13:59 
asciidoc
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 29-Окт-16 11:47 
Не прошло и 25 лет. Хотя подождите.. прошло :3
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 29-Окт-16 15:23 
Гламурненько. Для домохозяек пойдет. А мне в txt удобнее.
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено OIIOPA3PbIBATEb , 29-Окт-16 16:28 
Тож с VT100 сидиш? ;-)
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено phoenix.com , 29-Окт-16 16:34 
шаблон для документации больно гламурный и неудобный.
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Рика Нипа , 30-Окт-16 23:51 
Можешь пересобрать с другой темой же.
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 30-Окт-16 02:49 
Доки всегда хорошо Еще бы нашлась нпаранеленивых челов  с хорошим знанием инглиша и естессна программирования для русификации  оных доков и   вобще красота была бы...
а так  сиди  вкуривай чего там  написано-  хоч  через переводчик, хочешь так...
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 30-Окт-16 09:01 
Лежит kernel.org. Видать все ломанулись почитать)
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено Аноним , 31-Окт-16 16:23 
Может еще и до TeXа дойдут. На ночь читать можно будет...
"Опубликован отформатированный вариант документации к ядру Li..."
Отправлено PnDx , 31-Окт-16 17:08 
CSS тамошний свои шрифты навязывает.
Больше (пока) не нашёл, чему придраться ;) Читаемость++