Результаты поиска по запросу "python-sphinx"

2 ответа

не имея никакого отношения к Perl.

я есть похожий вопросэто [https://tex.stackexchange.com/questions/5001/prevent-hyphenation-and-use-line-break-in-block-of-text] кроме Сфинкса и РСТ. А именно, я бы хотел запретить перенос текста в конце строки. Например, я хочу это: This is my ...

1 ответ

docutils.sourceforge.net/docs/user/rst/...

я есть список в моем первом файле, который выглядит следующим образом: - Item 1 - Item 2 - Item 3Это делает что-то вроде следующего (это именно то, что я хочу): Элемент 1Пункт 2Пункт 3Я хотел бы создать ссылки для каждого элемента, поэтому ...

1 ответ

Включение боковой панели в документации Python-Sphinx на основе темы sphinx-bootstrap

Я использую хорошую sphinx-bootstrap-theme 0.3.4 и пытаюсь применить ее поверх Sphinx Python Documentation Generator версии 1.2. Когда я строю документацию черезmake htmlЯ не получаю никакой боковой панели, хотя это показано, что возможно в ...

ТОП публикаций

1 ответ

Я тоже не эксперт, поэтому я могу упустить что-то действительно базовое. Но если я правильно понимаю, чтобы использовать оглавление, я должен создать кучу файлов .rst. Поэтому я должен продублировать структуру. Вместо этого я не создаю дополнительные файлы .rst: вся документация находится в исходном коде Python. Пожалуйста, поправьте меня, если я неправильно понял ваш ответ.

ал документировать проект Python с использованием Sphinx. Это первый раз, когда я его использую - я привык к инструментам, которые работают с JavaDoc-подобным синтаксисом, и у меня есть некоторые сомнения. Поскольку я хочу, чтобы документация ...

1 ответ

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

аюсь создать правильно вложенный список, используя следующий код (следующий сфинкс ...

1 ответ

@ Зейн, я согласен. Как любитель Doxygen, я слишком сильно упустил полностью автоматическое создание справочников по API. Проверьте мой ответ, так как некоторые другие опции теперь доступны.

равится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет/* .. */ комментарии, а также имеет свой собственный механизм самодокументирования, который, кажется, ...

2 ответа

 файл, после импорта.

ьзуя генератор sphinx doc, я пытаюсь использовать изображения .png для сборок HTML документации, а затем хочу использовать изображения .svg, используемые для сборок PDF / LATEx. Кто-нибудь знает, как «помечать» разделы как «только HTML-сборка» и ...

1 ответ

code.activestate.com/recipes/...

аю каркас, в котором я позволяю разработчикам описывать свой пакет, используя reStructuredText Я хочу разобрать этот reStructuredText в HTML, чтобы я мог показать его в графическом интерфейсе. Я знаком с отличным Сфинксом, но я никогда не ...

2 ответа

Это помогло мне, добавьте это внизу.

аюсь написать документацию для моего проекта в sphinx, и всякий раз, когда sphinx встречает OptionParser в моем модуле, он дает мне: sphinx-build: error: no such option: -bЯ подумал, что это невозможно, поэтому я написал простой модуль, чтобы ...

5 ответов

Любая идея о том, как это сделать, когда ваша документация находится в формате Google?

ользую Sphinx для создания документов для проекта Python. Выходной html не сохраняет разрывы строк, которые присутствуют в строке документации. Пример: Код def testMethod(arg1,arg2): """ This is a test method Arguments: arg1: arg1 description ...