Вопросы с тегом «python-sphinx»

Я ненавижу RST, но люблю сфинкса. Есть ли способ, что sphinx читает уценку вместо reStructuredText?

212 python  markdown  python-sphinx 

Я пытаюсь использовать Sphinx для документирования проекта на 5000 строк в Python. Имеет около 7 базовых модулей. Насколько я знаю, чтобы использовать autodoc, мне нужно написать такой код для каждого файла в моем проекте: .. automodule:: mods.set.tests :members: :show-inheritance: Это слишком утомительно, потому что у меня много файлов. Было бы …

149 python  python-sphinx  autodoc 

Как вставить перекрестную ссылку на страницу reST / Sphinx в подзаголовок или привязку на другой странице в том же наборе документации?

110 python-sphinx  restructuredtext 

По умолчанию Sphinx не создает документы для __init __ (self). Я пробовал следующее: .. automodule:: mymodule :members: и ..autoclass:: MyClass :members: В conf.py установка следующего только добавляет строку документации __init __ (self) в строку документации класса ( документация Sphinx autodoc, похоже, согласна с тем, что это ожидаемое поведение, но ничего …

108 python  python-sphinx  autodoc 

Я пытаюсь начать работать со Sphinx, но у меня постоянные проблемы. Команда: docs/sphinx-quickstart Отвечаю на все вопросы и все работает нормально. Команда: docs/ls Все нормально выглядит. Результат:build Makefile source Команда: sphinx-build -d build/doctrees source build/html Вроде работает. Мне удалось открыть файл index.html и увидеть «оболочку» того, что я хочу. Когда …

107 python  python-sphinx  autodoc 

Я использую sphinx и плагин autodoc для создания документации API для моих модулей Python. Хотя я вижу, как красиво документировать определенные параметры, я не могу найти пример того, как документировать **kwargsпараметр. Есть ли у кого-нибудь хороший пример четкого способа их документировать?

99 python  python-sphinx  autodoc 

Закрыто . Этот вопрос должен быть более конкретным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он фокусировался только на одной проблеме, отредактировав этот пост . Закрыт 2 года назад . Уточните этот вопрос Мне нравится Doxygen создавать документацию по коду C или …

94 python  documentation  python-sphinx  doxygen  docstring 

Я пытаюсь создать правильно вложенный список, используя следующий код (следуя документам Sphinx и documenttils ): 1. X a. U b. V c. W 2. Y 3. Z Я ожидаю, что это приведет к двум OLs, но вместо этого я получаю следующий результат: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol …

90 markup  restructuredtext  python-sphinx 

Я использую Sphinx для документирования проекта, отличного от Python. Я хочу распределить ./docпапки в каждом подмодуле, содержащие submodule_name.rstфайлы для документирования этого модуля. Затем я хочу поместить эти файлы в главную иерархию, чтобы создать спецификацию для всего дизайна. Т.е.: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs …

90 python  python-sphinx  symlink  toctree 

Я хочу добавить ссылку на метод в моем классе из строки документации другого метода того же класса. Я хочу, чтобы ссылка работала в sphinx и предпочтительно также в Spyder и других IDE Python. Я пробовал несколько вариантов и нашел только один, который работает, но он громоздкий. Предположим следующую структуру в …

87 python  python-sphinx  spyder 

Сборка Sphinx docs на read-the-docs завершается с ошибкой (полный журнал ниже): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Я сделал что-то не так или это ошибка в read-the-docs? Локальная сборка Sphinx Docs работает нормально. Полный журнал ошибок при чтении документов: Read the Docs build information Build id: 10299638 Project: …

25 python  python-sphinx  read-the-docs 

Пожалуйста, скачайте файл simple.7zи установите его в свой sphinx, чтобы воспроизвести проблемы, которые я описал здесь, чтобы воспроизвести его, вы можете запустить: make clean make html загрузите и установите в своем сфинксе, чтобы воспроизвести проблемы Есть две статьи sample/source, содержание одинаковое, только разница в названии. cd sample ls source |grep …

14 python  python-sphinx