Вопросы по теме 'python-sphinx'
Sphinx: проиндексированный элемент с перекрестными ссылками
Как я могу сделать перекрестную ссылку на проиндексированный элемент внутри документа reStructuredText?
Например, как я могу ссылаться на SectionB:
.. index::
pair: SectionA; SectionB
SectionB
--------
SectionB description.
Я...
2885 просмотров
schedule
01.08.2022
Python doctests / sphinx: руководство по стилю, как их использовать и иметь читаемый код?
Я люблю doctests, это единственный тестовый фреймворк, который я использую, потому что его так быстро писать, и поскольку он используется со sphinx, он почти без усилий создает такую отличную документацию...
Однако очень часто я делаю такие...
790 просмотров
schedule
01.04.2024
Использование Sphinx с расширением C, созданным distutils
Я написал модуль Python, включающий подмодуль, написанный на C: сам модуль называется foo , а часть C — foo._bar . Структура выглядит так:
src/
foo/__init__.py <- contains the public stuff
foo/_bar/bar.c <- the C extension
doc/...
953 просмотров
schedule
07.12.2023
Как компактно отформатировать ссылку Sphinx/reStructuredText как код?
Я создаю документацию Sphinx и в идеале хотел бы, чтобы мои строки документации были как можно более читаемыми в коде, поэтому я хотел бы сохранить reStructuredText до минимума, при этом как можно больше моей документации по Sphinx создается...
235 просмотров
schedule
15.04.2024
Как сделать мой пакет доступным для импорта без инициализации графического процессора
Я пишу пакет Python, который выполняет вычисления на GPU с использованием библиотеки PyCUDA. PyCUDA необходимо инициализировать устройство GPU (обычно путем импорта pycuda.autoinit ), прежде чем можно будет импортировать любой из его подмодулей....
210 просмотров
schedule
19.10.2022
Списки reStructuredText с пользовательским перечислителем
Рассмотрим пункт "2-3)" в списке "Сложность" на http://en.cppreference.com/w/cpp/container/vector/vector . Как я могу добиться того же в reStructuredText/Sphinx?
Самое близкое, что я получил, было писать
| 1) ...
| 2-3) ...
| 4) ...
но...
89 просмотров
schedule
17.04.2024
Sphinx, как зеркалировать README.rst и index.rst
Используя sphinx, как я могу включить мой README.rst в корне моего репозитория git в мой index.rst в моих документах sphinx? Я использую apidoc и autodoc. Отличным примером является APScheduler, если вы посмотрите, вы заметите, что их docs /...
325 просмотров
schedule
30.07.2022
Перекрестная ссылка Sphinx не работает
В моей документации в стиле scipy у меня есть:
..., see :ref:`notes <filt_int_notes>`.
Other text.
.. _filt_int_notes:
Notes
-----
Some cool notes.
Согласно Добавление перекрестной ссылки на подзаголовок или привязка на другой...
1461 просмотров
schedule
28.09.2022
Ошибка: не допускается содержание в директиве рубрики
Файл, который я пытаюсь добавить, содержит ряд рубрик, но с ними я получаю странную ошибку. Должно быть, я делаю что-то глупое, но я не могу понять, в чем дело. Вот мой документ:
==========================
Coding Conventions...
2103 просмотров
schedule
07.04.2024
Замена Python Sphinx/rest для длинных имен, определяющих правило замены в том же исходном файле
Сообщение Python Sphinx, ссылающееся на длинные имена , предоставило один ответ, который был очень близок к тому, что я искал for в отношении директив замены для длинных имен классов.
def exampleFunction():
'''Here is an example docstring...
182 просмотров
schedule
09.10.2022
Sphinx: ссылка на встроенные двоичные файлы (PDF)
Я использую sphinx и RST для создания технической документации в формате HTML, и у меня возникают проблемы с получением локальной ссылки PDF для работы в качестве гиперссылки. Я видел, как люди использовали :download: для ссылки на локальные...
2006 просмотров
schedule
26.12.2023
Удалить пробел в верхней части оглавления sphinx pdflatex
Я создаю документацию по пакету python в формате HTML и в виде латексного PDF. Созданный по умолчанию латексный PDF-файл (ручной класс) имеет большое количество пробелов в верхней части оглавления вокруг текста «СОДЕРЖАНИЕ». Я не очень хорошо знаком...
594 просмотров
schedule
16.03.2024
используйте один и тот же контент README в sphinx и github - относительные ссылки
Я добавляю страницу Read The Docs для своего проекта. На данный момент я хочу, чтобы на моей домашней странице Read The Docs было то же содержимое, что и в моем файле README. Мой файл docs/index.rst выглядит так:
.. include:: ../README.rst
.....
847 просмотров
schedule
03.08.2022
Sphinx удаляет форматирование кода из справочника пользовательского кода
У меня есть следующие занятия:
class A:
def x():
""" Do the thing. """
class B(A):
def x():
"""
Do the thing, but better than the :py:meth:`parent <A.x>`
"""
Весь модуль autodoc ed. Я хотел бы...
147 просмотров
schedule
12.12.2023
Удалить рамки таблицы в формате pdf
Я использую python sphinx для создания руководств пользователя. Для этого мне нужно отформатировать довольно большое количество таблиц.
В некоторых случаях мы используем таблицы, чтобы аккуратно выровнять изображения и тексты. В упомянутом случае...
325 просмотров
schedule
19.05.2024
Исключить комментарии заголовков при создании документации с помощью sphinx
Я пытаюсь использовать sphinx для создания документации для моего пакета Python. Я включил хорошо документированные строки документации во все свои функции. Я вызвал sphinx-quickstart для создания шаблона, заполнил шаблон и вызвал make html...
815 просмотров
schedule
08.05.2024
Отображение окна предупреждения на страницах, сгенерированных python-sphinx
Как отобразить окно предупреждения в html, сгенерированном с помощью sphinx-build ?
Warning
Do not use the directives sectnum, header and footer.
Я хочу показать вышеуказанное сообщение примерно так: (извините, SO не t позвольте мне...
1188 просмотров
schedule
13.05.2024
Можно ли в Sphinx сохранить длинные строки?
В моем входном файле restructuredText для Sphinx есть длинная строка:
This is a long line text that I want to keep as a long single line. It should not be wrapped in the text output.
Используя конструктор текста Sphinx, я получаю такой вывод:...
996 просмотров
schedule
20.04.2024
Как документировать связываемые константы с помощью sphinx
Как я могу правильно задокументировать константу, скажем, foo = 4 в коде Python(3) с помощью Sphinx таким образом, чтобы я мог получить к ним доступ с помощью чего-то вроде :attr:`foo`?
Моим текущим решением было бы создание класса и перемещение...
584 просмотров
schedule
14.08.2022
Документ Sphinx борется с набором текста при импорте
сегодня я установил простую работу сфинкса для моего проекта python. Когда я нажимаю "make html", он вылетает со следующими сообщениями:
ВНИМАНИЕ: autodoc: не удалось импортировать модуль myname.mymodule; возникло следующее исключение:...
305 просмотров
schedule
28.12.2023
