The OpenNET Project / Index page

[ новости /+++ | форум | wiki | теги | ]

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

"Опубликован отформатированный вариант документации к ядру Linux"  +/
Сообщение от opennews (??) on 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
Новость: https://www.opennet.ru/opennews/art.shtml?num=45393

Ответить | Правка | Cообщить модератору

Оглавление

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


1. "Опубликован отформатированный вариант документации к ядру Li..."  +3 +/
Сообщение от Аноним (??) on 29-Окт-16, 11:26 
Прекрасно
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

2. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от ArchUser on 29-Окт-16, 11:41 
Что лучше: MarkDown (md) или reStructuredText (RST)?
Думаю, в чем самому писать для проекта.
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

4. "Опубликован отформатированный вариант документации к ядру Li..."  +1 +/
Сообщение от freehck email(ok) on 29-Окт-16, 11:59 
Не велика разница. Есть публикаторы, которые позволяют просмотреть эти файлики в любом удобном виде.

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

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

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

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

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

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

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

10. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от QuAzI (ok) on 29-Окт-16, 14:53 
В чём он более примитивный? Что такого в RST есть, чего нет в md?
И дайте линк на статистику, что чаще используют =)
Ответить | Правка | ^ к родителю #9 | Наверх | Cообщить модератору

15. "Опубликован отформатированный вариант документации к ядру Li..."  +6 +/
Сообщение от irinat (ok) on 29-Окт-16, 16:57 
> Что такого в RST есть, чего нет в md?

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

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

17. "Опубликован отформатированный вариант документации к ядру Li..."  +1 +/
Сообщение от KonstantinB (ok) on 29-Окт-16, 23:27 
В классическом markdown Грубера нет даже таблиц.

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

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

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

http://commonmark.org/

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

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

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

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

24. "Опубликован отформатированный вариант документации к ядру Li..."  –2 +/
Сообщение от myhand (ok) on 30-Окт-16, 14:26 
> В чём он более примитивный? Что такого в RST есть, чего нет в md?

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

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

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

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

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

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

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

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

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

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

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


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

5. "Опубликован отформатированный вариант документации к ядру Li..."  –2 +/
Сообщение от Чаёвник on 29-Окт-16, 12:33 
Markdown на хабре, на гитхабе, битбакете и гитлабе, в каком-то мессенджере частичная поддержка была, редакторов троху есть даже мобильных. А про этот формат ни соуху ни духу. И да, md читаем даже как plain text
Ответить | Правка | ^ к родителю #2 | Наверх | Cообщить модератору

8. "Опубликован отформатированный вариант документации к ядру Li..."  –3 +/
Сообщение от myhand (ok) on 29-Окт-16, 14:30 
В тайге с медведями живешь?
Ответить | Правка | ^ к родителю #5 | Наверх | Cообщить модератору

25. "Опубликован отформатированный вариант документации к ядру Li..."  +3 +/
Сообщение от Аноним (??) on 30-Окт-16, 21:17 
Нужда в спецсофте - жирный минус. Особенно для документации, что ни говори.
Ответить | Правка | ^ к родителю #8 | Наверх | Cообщить модератору

31. "Опубликован отформатированный вариант документации к ядру Li..."  –1 +/
Сообщение от myhand (ok) on 02-Ноя-16, 21:56 
> Нужда в спецсофте - жирный минус.

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

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

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

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

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

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

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

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

6. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от QuAzI (ok) on 29-Окт-16, 13:16 
Весьма радует в md возможность встраивать исходные коды с подсветкой синтаксиса и блоксхемы, например так https://github.com/weijiaming/QtCreator-Markdown-Editor-Plugin
Ответить | Правка | ^ к родителю #2 | Наверх | Cообщить модератору

16. "Опубликован отформатированный вариант документации к ядру Li..."  +1 +/
Сообщение от Andrey Mitrofanov on 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/

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

23. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от QuAzI (ok) on 30-Окт-16, 13:42 
Фичи впечатляют. Но исходники всё-таки хуже читаемы (особенно когда видишь это первый раз как plain text и хз про особенности разметки)
Ответить | Правка | ^ к родителю #16 | Наверх | Cообщить модератору

7. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от user (??) on 29-Окт-16, 13:59 
asciidoc
Ответить | Правка | ^ к родителю #2 | Наверх | Cообщить модератору

3. "Опубликован отформатированный вариант документации к ядру Li..."  +6 +/
Сообщение от Аноним (??) on 29-Окт-16, 11:47 
Не прошло и 25 лет. Хотя подождите.. прошло :3
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

12. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от Аноним (??) on 29-Окт-16, 15:23 
Гламурненько. Для домохозяек пойдет. А мне в txt удобнее.
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

13. "Опубликован отформатированный вариант документации к ядру Li..."  +3 +/
Сообщение от OIIOPA3PbIBATEb on 29-Окт-16, 16:28 
Тож с VT100 сидиш? ;-)
Ответить | Правка | ^ к родителю #12 | Наверх | Cообщить модератору

14. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от phoenix.com on 29-Окт-16, 16:34 
шаблон для документации больно гламурный и неудобный.
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

26. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от Рика Нипа on 30-Окт-16, 23:51 
Можешь пересобрать с другой темой же.
Ответить | Правка | ^ к родителю #14 | Наверх | Cообщить модератору

20. "Опубликован отформатированный вариант документации к ядру Li..."  –2 +/
Сообщение от Аноним (??) on 30-Окт-16, 02:49 
Доки всегда хорошо Еще бы нашлась нпаранеленивых челов  с хорошим знанием инглиша и естессна программирования для русификации  оных доков и   вобще красота была бы...
а так  сиди  вкуривай чего там  написано-  хоч  через переводчик, хочешь так...
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

22. "Опубликован отформатированный вариант документации к ядру Li..."  –1 +/
Сообщение от Аноним (??) on 30-Окт-16, 09:01 
Лежит kernel.org. Видать все ломанулись почитать)
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

28. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от Аноним (??) on 31-Окт-16, 16:23 
Может еще и до TeXа дойдут. На ночь читать можно будет...
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

29. "Опубликован отформатированный вариант документации к ядру Li..."  +/
Сообщение от PnDx (ok) on 31-Окт-16, 17:08 
CSS тамошний свои шрифты навязывает.
Больше (пока) не нашёл, чему придраться ;) Читаемость++
Ответить | Правка | ^ к родителю #0 | Наверх | Cообщить модератору

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

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




Спонсоры:
Inferno Solutions
Hosting by Hoster.ru
Хостинг:

Закладки на сайте
Проследить за страницей
Created 1996-2020 by Maxim Chirkov
Добавить, Поддержать, Вебмастеру