python-sphinx — все вопросы

1ответ
4 голоса
Документирование файлов с помощью «из x import *»
Можно ли использовать sphinx's .. automodule :: и другие автоматические функции для документирования модулей, которые содержат операторы from x import *, не включая всю документацию из импортированн
1ответ
4 голоса
Python: Как я могу определить в sphinx, какие файлы и каталоги .rst следует использовать?
Как определить в sphinx, какие файлы и каталоги .rst следует использовать? Я хочу включить автоматический генератор документации в мой скрипт тестирования /сборки /документации. sphinx-quickst
1ответ
4 голоса
Проблемы с автодоком и явно указанными атрибутами экземпляра
Я написал класс Python и создал документацию с помощью sphinx. Например, класс выглядит так: class Aclass(object): """ my class """ def __init__(self): """ constructor """
1ответ
4 голоса
гиперссылка на внешний git-репозиторий в документации Sphinx PDF
Внешние гиперссылки на git-репозиторий в форме .. _Git repo: git://github.com/migueldvb/repo.git правильно отображаются в документации HTML, но они не отображаются в файле PDF. При запуске pyth
1ответ
4 голоса
Как обслуживать статические ресурсы без изображений с сайта readthedocs?
У меня есть папка assets в моем docs Изображения правильно встраиваются в мою документацию, но любые ссылки на образцы входных файлов (статические файлы, которые являются входными данными для двои
1ответ
4 голоса
Условно скомпилировать разделы документа в Sphinx
Мы планируем создать руководство пользователя для нашего программного проекта. В настоящее время все, что связано с кодом, задокументировано в Sphinx, и мы хотели бы использовать Sphinx для руководс
1ответ
4 голоса
Двойное предупреждение индекса при сборке сфинкса; Как включить файл без индексации его содержимого?
Я хочу создать файл single_html.rst, содержащий все мои class /method /attribute /etc ..., но также разделяет классифицированные символы на отдельные страницы. например. single_html.rst .. s
2ответа
4 голоса
Сгенерированные сфинксом html-страницы выглядят по-разному при переносе в хранилище git на диске NAS
Я создал некоторую документацию, используя Sphinx на своем локальном диске. Затем я инициализировал репозиторий git на сетевом диске и fetched моя работа с локального диска, чтобы я мог поделиться с
2ответа
4 голоса
документация sphinx, дающая мне предупреждение о ссылках на toctree
Contents: .. toctree:: :maxdepth: 2 foo.rst bar.rst Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` Я пытаюсь построить его, используя sphinx
3ответа
4 голоса
Есть ли способ разбить слово на несколько строк в ячейке таблицы в reStructuredText, чтобы оно отображалось как одно слово в выводе?
Скажем, у меня есть таблица в reStructuredText как: +---------------+---------------------------+ | key | value | +===============+===========================+ | shor
1ответ
4 голоса
Есть ли способ позволить классам наследовать документацию своего суперкласса с помощью sphinx?
Предположим, у меня есть класс class A(object): def myfunction(): """A.""" pass и подкласс class B(A): def myfunction(): pass можно ли наследовать документ API B.myfunction
1ответ
4 голоса
Сфинкс autosummary с toctree также перечисляет импортированные члены
Я использую Sphinx и autosummary для создания документации программного обеспечения Python. Он работает хорошо, но в созданных файлах .rst также перечислены импортированные функции и классы, что мне
1ответ
4 голоса
Как добавить ссылку «предыдущая глава» и «следующая глава» в документацию, созданную Sphinx?
Когда я просматриваю документацию, на большинстве страниц внизу есть ссылка на предыдущую главу и ссылку на следующую главу, например virtualenv . Я не могу выяснить, как это сделать для документаци
1ответ
4 голоса
сфинкс для нескольких отдельных документов
Я довольно новичок в Sphinx, документирую свой проект на сервере.Теперь коллега видит, чем я занимаюсь, и она хочет сделать то же самое - документировать свой проект на том же сервере.Проекты не связа
2ответа
4 голоса
Сфинкс: Ошибка импорта в не документированном пакете.Есть ли способ «пропустить»?
Я пытаюсь начать документирование небольшого проекта Python с помощью Sphinx.Я создал ---- +: = 0 =: + ----, где я попытался бы организовать (и автоматически сгенерировать) документацию для одного из
1ответ
4 голоса
Почему математические формулы не отображаются в Sphinx /pythonhosted.org?
Я не уверен, где именно проблема.Я разработал пакет Python под названием ---- +: = 0 =: + ----, который размещает свою документацию на pythonhosted.org (официальном сайте, где его автоматически размещ
1ответ
4 голоса
Как я могу показать унаследованных членов класса в моей документации Sphinx?
Я хочу задокументировать некоторые классы, которые все происходят из одного и того же базового класса с некоторыми общими атрибутами, и я хотел бы повторить документацию для каждого атрибута в подклас
2ответа
4 голоса
Как сделать ссылку на корневую страницу в intersphinx
Я включил ---- +: = 0 =: + ---- в моем проекте и добавил следующую конфигурацию:У меня есть следующее в моем ---- +: = 2 =: + ---- :Я хотел бы, чтобы ссылка указывала на ---- +: = 4 =: + ---- , корнев
4ответа
4 голоса
Что мне нужно сделать, чтобы «зарегистрировать» latexpdf для Sphinx?
Когда я запускаю Sphinx с использованием 'latexpdf', я получаю сообщение об ошибке, даже если у меня на компьютере установлена ​​полная рабочая установка TeXОшибка сфинкса: имя строителя latexpdf не з
3ответа
4 голоса
Как использовать синтаксис Python 3.5 в readthedocs в сочетании с autodoc?
Я хотел бы сгенерировать документацию (включая автоматически сгенерированную документацию с помощью autodoc) для моего проекта с использованием readthedocs.org .Тем не менее, мой проект использует син
1 2 3 4

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132