The OpenNET Project / Index page

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

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

30.12.2014 10:07

Опубликовано руководство по генератору документации Sphinx. В руководстве подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs.

  1. Главная ссылка к новости (http://librerussia.blogspot.ru...)
Автор новости: OneManRevolution
Лицензия: CC BY 3.0
Короткая ссылка: https://opennet.ru/41364-sphinx
Ключевые слова: sphinx
При перепечатке указание ссылки на opennet.ru обязательно


Обсуждение (27) Ajax | 1 уровень | Линейный | +/- | Раскрыть всё | RSS
  • 1.1, Аноним (-), 11:42, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • –1 +/
    генераторатор?
    что это?
     
     
  • 2.2, анонисимус (?), 11:44, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • –3 +/
    Вот как это примерно: http://referats.yandex.ru/referats/
     
  • 2.3, Аноним (-), 12:18, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • –3 +/
    Doxygen нэ слищаль?
     
  • 2.4, Аноним (-), 12:38, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +2 +/
    Это как генератор, только для бидонистов.
     
  • 2.6, commiethebeastie (ok), 13:05, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    В шараге MS Word изучали?
     
     
  • 3.23, Аноним (-), 22:02, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    Это называлось "Информатика"
     
  • 2.9, Аноним (-), 13:47, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +2 +/
    Тулза для генераторации.
     
  • 2.25, Аноним (-), 22:41, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    тебе, дегенератору, это не нужно
     

  • 1.7, trdm (ok), 13:11, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    Это типа доскигена что-ли?
    Или что-то другое?
     
     
  • 2.8, бедный буратино (ok), 13:46, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +1 +/
    это типа википедии чё-то.

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

     
  • 2.19, myhand (ok), 17:16, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    > Это типа доскигена что-ли?

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

    http://sphinx-doc.org/

     

  • 1.10, Парацельс (?), 14:27, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • +2 +/
    Офисные пакеты — это WYSIWYG («что видишь, то и получишь») редакторы, которые непосредственно работают с конечным форматом документа.

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

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

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

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

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


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

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

     
     
  • 2.13, Аноним (-), 15:30, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +1 +/
    Круто! Но вопрос-то был про генератораторы.
     
     
  • 3.16, Парацельс (?), 16:11, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • –1 +/
    > Круто! Но вопрос-то был про генератораторы.

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

     
     
  • 4.21, Аноним (-), 19:04, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +2 +/
    > Тогда перечитайте ещё раз мой комментарий.

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

     

  • 1.11, Rodegast (ok), 14:40, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • –1 +/
    Почему нет PDF?
     
     
  • 2.14, Вова (?), 16:05, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    PDF есть.
     

  • 1.12, Аноним (-), 15:25, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • –5 +/
    Почему нет docx ?
     
     
  • 2.15, Парацельс (?), 16:10, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +1 +/
    Вообще-то есть.
     
     
  • 3.20, Вова (?), 18:41, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    Где??? Есть что-то кроме перечисленных в это ответе: https://stackoverflow.com/a/15388552 ?
     
  • 2.17, Вова (?), 16:21, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    > Почему нет docx ?

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

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

     
  • 2.24, Аноним (-), 22:04, 30/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    Ненужно
     

  • 1.18, vitalif (ok), 16:50, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • +1 +/
    asciidoc мне кажется поприкольней
     
  • 1.22, Аноним (22), 19:37, 30/12/2014 [ответить] [﹢﹢﹢] [ · · · ]  
  • –1 +/
    Ещё один TeX?
     
     
  • 2.26, Акроним (?), 11:03, 31/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    Гораздо проще
     
  • 2.27, YetAnotherOnanym (ok), 18:12, 31/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    Здесь нельзя признаваться в знании технологий, существовавших до рождения школоты. Видишь, уже первый минус получил.
    Не буду его перебивать плюсом. Он у тебя будет как медаль, на самом деле.
     
     
  • 3.28, myhand (ok), 21:23, 31/12/2014 [^] [^^] [^^^] [ответить]  
  • +/
    > Не буду его перебивать плюсом.

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

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

     

     Добавить комментарий
    Имя:
    E-Mail:
    Текст:



    Партнёры:
    PostgresPro
    Inferno Solutions
    Hosting by Hoster.ru
    Хостинг:

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