Я изо всех сил пытаюсь понять, как разместить документацию для конкретных членов моего класса Python в определенных разделах моей документации Sphinx, в идеале, при автоматическом документировании остальных в другом разделе.
У меня есть класс Python
class MyClass(object):
def funky(self, arg):
"""Some docs."""
...
определенный в my/module.py
, который работает, как и ожидалось, и я могу документировать без проблем, используя
***************************
MyModule - :mod:`my.module`
***************************
.. automodule:: my.module
.. autoclass:: MyClass
:members:
:undoc-members:
:show-inheritance:
Но когда я пытаюсь получить больше контроля над организацией моей документации, я не могу заставить все работать. В частности, я хотел бы, чтобы некоторые участники были задокументированы в явных разделах (здесь показан только один, но их может быть несколько), а остальные автоматически задокументированы как группа.
Но когда я пытаюсь это сделать, например,
***************************
MyModule - :mod:`my.module`
***************************
To document
===========
Things that are not yet documented.
.. automodule:: my.module
.. autoclass:: MyClass
:members:
:undoc-members:
:show-inheritance:
:exclude-members: funky
Funky things
------------
Some funky things.
.. automethod:: funky
я получил
ВНИМАНИЕ: не знаете, какой модуль импортировать для автодокументирования u'funky' (попробуйте поместить в документ директиву "module" или "currentmodule" или указать явное имя модуля)
но без вариаций
.. currentmodule:: my.module
.. class:: MyClass
.. automethod:: funky
or
.. currentmodule:: my.module
.. automethod:: funky
и т. д. доставь меня куда угодно.
Как мне автоматически задокументировать некоторых членов моего класса в определенных местах моей документации Sphinx?
.. automethod:: MyClass.funky
или.. automethod:: my.module.MyClass.funky
работает? - person mzjn   schedule 03.12.2015automethod
вместоautoattribute
и перепуталautofunction
с обоими. Также есть ли способ избежать указания имени класса каждый раз?module::
иclass::
не помогают. - person orome   schedule 03.12.2015