Запитання з тегом «python-sphinx»

Я ненавиджу RST, але люблю сфінкса. Чи існує спосіб, як сфінкс читає розмітку замість 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 

Сфінкс за замовчуванням не генерує документи для __init __ (self). Я спробував таке: .. automodule:: mymodule :members: і ..autoclass:: MyClass :members: У Conf.py, встановивши наведене нижче, додає лише докстринг __init __ (self) до класу docstring (документація на autodoc Sphinx, схоже, погоджується, що це очікувана поведінка, але нічого не згадує щодо …

107 python  python-sphinx  autodoc 

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

104 python  python-sphinx  autodoc 

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

99 python  python-sphinx  autodoc 

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

94 python  documentation  doxygen  docstring  python-sphinx 

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

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 …

90 python  python-sphinx 

Я хочу додати посилання на метод у своєму класі з документації іншого методу того ж класу. Я хочу, щоб посилання працювало у сфінксі, переважно також у Spyder та інших середовищах розробки Python. Я спробував кілька варіантів і знайшов лише один, який працює, але він громіздкий. Нехай наступна структура в mymodule.py …

87 python  python-sphinx  spyder 

Як відформатувати текст у позначеному посиланні в reStructuredText? Зокрема, я хочу створити такий HTML з мого першого: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> Результат повинен виглядати так: optparse.OptionParser документація де частина "optparse.OptionParser" має шрифт фіксованої ширини. я намагався ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ проте це дало <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ що …

82 python-sphinx  restructuredtext 

Збірка документів Sphinx на документах для читання не вдається з наступною помилкою (повний журнал нижче): 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) Я зробив щось не так або це помилка в документах для читання? Місцева збірка документів Sphinx працює добре. Повний журнал помилок на документах для читання: Read the …

25 python  python-sphinx  read-the-docs 

Завантажте файл simple.7zта встановіть у своєму сфінксі, щоб відтворити проблеми, які я описав тут, щоб відтворити його, ви можете запустити: make clean make html завантажте та встановіть у своєму сфінксі для відтворення проблем У статті є дві статті sample/source, зміст однаковий, різниця лише в заголовку. cd sample ls source |grep …

14 python  python-sphinx