Показывать только метод со строкой документации со Sphinx - PullRequest
Новая
       4

Показывать только метод со строкой документации со Sphinx

0 голосов
/ 20 января 2020

Как сделать так, чтобы sphinx показывал в документации только методы, у которых есть строка документа, скажем, у нас есть простой класс 

class A:

def method_a(self, x, y):
    """
    some explanation of method_a

    Args:
        x: some argument x
        y: some argument y

    """
    pass

def method_b(self, x, y):
    pass

Я хочу, чтобы sphinx создавал документацию, которая не показывает method_b, у которого нет строки документации. У меня есть несколько причин, чтобы не делать method_b приватным. Как это можно сделать?

...