Я установил Sphinx, чтобы документировать некоторые модули и класс python, над которыми я работаю. Хотя язык разметки выглядит очень красиво, мне не удалось автоматически документировать код питона.
В принципе, у меня есть следующий модуль python:
SegLib.py
И класс, называемый Seg в нем. Я хотел бы отобразить docstrings класса и модуля в сгенерированном документе sphinx и добавить к нему дополнительный форматированный текст.
Мой index.rst выглядит следующим образом:
Contents:
.. toctree::
:maxdepth: 2
chapter1.rst
и chapter1.rst:
This is a header
================
Some text, *italic text*, **bold text**
* bulleted list. There needs to be a space right after the "*"
* item 2
.. note::
This is a note.
See :class:`Seg`
Но Seg просто напечатан жирным шрифтом и не связан с автогенерированной документацией класса.
Попытка: См.: class: Seg Модуль: mod: 'SegLib' Модуль: mod: 'SegLib.py'
Не помогло. Любые идеи или хорошие ссылки на учебники?
Изменить: изменил SegLib на сегменты (спасибо, iElectric!) и изменил chapter1.rst на: Модуль: mod: segments --------------------------
.. automodule:: segments.segments
.. autoclass:: segments.segments.Seg
Тем не менее, невозможно заставить sphinx напрямую документировать функции внутри класса, а лучше - автоматически добавлять все функции внутри класса в документ. Пробовал
.. autofunction:: segments.segments.Seg.sid
и получил:
autodoc can't import/find function 'segments.segments.Seg.sid', it reported error: "No module named Seg"
Любые идеи о том, как автоматически записывать функции и классы с помощью короткой команды?
Уди
