2012-04-26 4 views
0

делает вывод help(something) следующим языком разметки, который легко форматировать в html? Я знаю о pydoc -w [topic], но есть две проблемы:Язык разметки вывода из функции помощи python?

  • настройки стиля не легко (http://bugs.python.org/issue10716) и
  • pydoc -w терпит неудачу по некоторым темам (HTTP: // stackoverflow.com/a/10333615/1318686)

Ниже приведен пример вывода, генерируемого help('def'). Он имеет некоторые типичные характеристики других языков разметки. Например. пространства для кодовых блоков, `для встроенного кода, ** для выделения ...

Любые идеи?

Спасибо!

Function definitions 
******************** 

A function definition 

Multiple decorators are applied in 
nested fashion. For example, the following code: 

    @f1(arg) 
    @f2 
    def func(): pass 

just like a function defined by a lambda form. The "``def``" form is 
actually more powerful since it allows the execution of multiple 
statements. 

**Programmer's note:** Functions are first-class 

ответ

1

Большинство людей используют reStructuredText и использовать Sphinx, чтобы преобразовать его в HTML и другие форматы.

Нет требований к тому, как форматировать docstring функции.

+0

отлично, спасибо! Могу ли я использовать эти инструменты для замены 'pydoc -w [topic]'? Я в основном хочу создавать файлы справки «на лету» в html, не обязательно будучи в сети ... – user2503795

Смежные вопросы