LINUX.ORG.RU

Sphinx сдуру включает в документацию доки от импортированных функций

 ,


0

1

Есть у меня, джентельмены, питоний код, который я хочу задокументировать. Например - вот такой.

# encoding: utf-8
"""
This module does blah blah!.

"""
import numpy.random
from numpy.random import uniform

class UberMegaClass(object):
    """HELL YEAH!!!!"""
    def __init__(self, num_of_something):
        print("!!!!!")
        self.num_of_something = num_of_something

    def do_something(self, arg1, arg2=None):
        print(self.num_of_something)

Я хватаю sphinx-apidoc, создаю им документацию, собираю её через make html, и всё бы круто. Но есть одна беда: дьявольский Sphinx считает, что функции, импортированные в модуль, относятся к моему модулю же. А значит - ему надо документировать и их. Таким образом, в документацию к моему проекту включается и документация от некоторых функций NumPy. Конкретно в этом случае - от random.uniform.

Как бы мне это забороть?


Ответ на: комментарий от Yak

Там есть такой пункт в документации: Skipping members

pylin ★★★★★ ()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.