Вопросы по теме 'python-sphinx'
Сфинкс лучше ЛаТекса в написании руководств / книг?
Только несколько человек рекомендовал использовать Сфинкс в начале года.
В последнее время сфинкс развивается довольно быстро. Сегодня я заметил, что Sage перешел с прямого редактирования с LaTex на Sphinx. Это видно из ответа Уильяма Штейна...
8218 просмотров
schedule
06.07.2022
Использование sphinx / miktex для создания файлов PDF, отображающих текст UTF8 на японском языке (CJK) в окнах
У меня есть документация в ReSt (UTF8), и я использую sphinx для создания файлов HTML и latex. (Нет проблем с преобразованием HTML)
Затем я хочу преобразовать полученный файл латекса в PDf. В настоящее время я использую команду pdflatex.exe...
3192 просмотров
schedule
27.12.2022
Как загрузить html-документацию, созданную из sphinx, в github?
Я только что задокументировал множество своего кода и научился использовать sphinx для создания документации. Я хочу включить это в свою страницу проекта github, но я не знаю, как это сделать. Кто-нибудь знает существующий учебник или простой шаг...
8399 просмотров
schedule
20.01.2023
Sphinx (инструмент для документации): установить ширину табуляции в выводе
Как вы устанавливаете ширину табуляции в выводе HTML фрагментов кода Sphinx, выделенных Pygments? По умолчанию это надоедливая 8, но я хочу 4. Не нашел ни слова об этой настройке в Sphinx conf.py.
2057 просмотров
schedule
11.06.2022
Создание документации по коду PHP с помощью Sphinx?
Sphinx — это библиотека Python для создания красивой документации из набора текстовых файлов в формате ReST. Не тот инструмент, который используется для полнотекстового поиска
Я также полностью осведомлен об инструментах doxygen/phpdoc. Я пытаюсь...
10867 просмотров
schedule
14.11.2022
Изображения в предостережениях/предупреждениях/уведомлениях
В настоящее время я использую Sphinx для создания вывода LaTeX, который преобразуется в PDF для вывода в книжном стиле с использованием pdftex.
В настоящее время у меня есть уведомления, предупреждения и другие «предостережения», отображаемые...
892 просмотров
schedule
16.06.2022
Документация по переходу с Javadoc на Python
Так что я немного привык к документации в стиле Javadoc. Просматривая различные примеры кода Python, я обнаружил, что, на первый взгляд, в документации кажется отсутствует много информации.
Хорошо: редко вы видите самоочевидные фрагменты...
4430 просмотров
schedule
14.05.2023
Sphinx, reStructuredText показать / скрыть фрагменты кода
Я документировал программный пакет, используя Sphinx и reStructuredText .
В моих документах есть несколько длинных фрагментов кода. Я хочу, чтобы они были скрыты по умолчанию, с помощью небольшой кнопки «Показать / скрыть», которая бы их...
11744 просмотров
schedule
20.06.2022
Использование Sphinx с Markdown вместо reST
Ненавижу reST, но люблю Сфинкса. Есть ли способ, которым Sphinx читает Markdown вместо reStructuredText?
54899 просмотров
schedule
11.12.2021
Заставить Sphinx генерировать документацию класса RST из pydoc
В настоящее время я переношу всю существующую (неполную) документацию на Sphinx .
Проблема в том, что в документации используются строки документации Python (модуль написан на C, но, вероятно, не имеет значения) и документация класса должна...
3957 просмотров
schedule
12.07.2022
«Неожиданное название раздела» со Sphinx — это проблема?
При работе
sphinx-build . html/
в моем каталоге doc/ я получаю следующий вывод:
$ sphinx-build . html/
Running Sphinx v0.6.4
No builder selected, using default: html
loading pickled environment... done
building [html]: targets for 0...
7304 просмотров
schedule
17.11.2022
Как я могу сделать атрибуты объекта документа Python/Sphinx объявленными только в __init__?
У меня есть классы Python с атрибутами объекта, которые объявляются только как часть запуска конструктора, например:
class Foo(object):
def __init__(self, base):
self.basepath = base
temp = []
for run in...
8539 просмотров
schedule
16.02.2023
Sphinx: размещение сегмента кода в первой строке элемента неупорядоченного списка
Я использую Sphinx для управления документацией моего проекта.
У меня есть неупорядоченный список, и я хочу, чтобы первая строка каждого элемента была сегментом кода. (Не встроенный, абзац.)
Как я могу это сделать?
293 просмотров
schedule
07.11.2022
Сфинкс для написания параллельного текста
Проблема: я пытаюсь написать «параллельный текст», используя reStructuredText . Под «параллельным текстом» я подразумеваю что-то вроде аннотированных художественных произведений, где текст находится в двух столбцах. В левом столбце содержится...
1245 просмотров
schedule
17.08.2023
Как сделать стол под зебру с помощью сфинкса? Или как использовать jQuery со Sphinx?
Я думаю, что таблица, созданная с помощью Sphinx, некрасива, поскольку она создает следующий HTML-код для таблицы.
<table border="1" class="docutils">
<colgroup>
<col width="43%" />
<col width="29%" />
<col width="29%"...
570 просмотров
schedule
31.01.2023
Структурирование документации Sphinx
Я начал документировать проект Python, используя Sphinx. Я использую его впервые - я привык к инструментам, которые работают с синтаксисом, подобным JavaDoc, и у меня есть некоторые сомнения.
Поскольку я хочу, чтобы документация отображалась рядом...
8370 просмотров
schedule
18.02.2024
Sphinx: автоматически маркировать заголовки?
Можно ли в Sphinx автоматически определять метки для заголовков? Я обнаружил, что мои документы в конечном итоге выглядят примерно так:
.._doing stuff:
Doing Stuff
-----------
You might also want :ref:`other stuff`.
.._other stuff:
Other...
925 просмотров
schedule
29.04.2024
Можно ли в документации Sphinx использовать имя модуля для указания включаемого образца кода?
Я хотел бы включить пример кода в свою документацию по сфинксу. Однако я не хочу обращаться к файлу по его пути, а скорее укажу его по имени модуля.
То есть вместо того, чтобы делать это так, как указано здесь Показ примеров кода
.....
189 просмотров
schedule
11.07.2022
Добавление темы в документацию Sphinx
Я пытаюсь добавить некоторый дизайн темы/шаблона в свою документацию, и мне было интересно, есть ли способ добавить строку HTML в строку 20 каждой HTML-страницы, созданной Sphinx?
208 просмотров
schedule
11.02.2023
Документировать python с помощью Eclipse/Pydev
Я новичок в разработке на Python и использую Eclipse/Pydev. Есть ли хороший способ интегрировать инструменты для создания документации (например, Sphinx, pydoc) в IDE, чтобы иметь хороший рабочий процесс, возможно, отображая документацию на отдельной...
4517 просмотров
schedule
13.02.2023
