Я создаю документ с использованием sphinx. Формат строк документации, который я использовал, - это строки документов в стиле NumPy. Хотя он читает и отображает все другие заголовки (параметры, возвраты, выходы и т. Д.) В браузере, он не отображает заголовок «Атрибуты». Я использую «sphinx_rtd_theme» в качестве темы HTML.
Я попробовал следующие подходы:
1. Используйте заголовок Attributes в строках документации класса, чтобы определить все атрибуты класса.
2. Используйте autoattribute в файле .rst и следуйте формату #: для определения атрибута класса.
class Demo:
"""Demo class.
Attributes
-----------
a : int
variable 1
b : int
variable 2
"""
def __init__(self, par1, par2):
"""Constructor.
Parameters
-----------
par1 : int
parameter 1
par2 : int
parameter 2
"""
self.a = par1
self.b = par2
Ожидаемый результат-
Attributes(I want this as title)
- a(int) : variable 1
- b(int) : variable 2
Фактический результат - a и b отображаются как заголовок, а не как «Атрибуты»
a
variable 1
Type
int
b
variable 2
Type
int
Работает, как и ожидалось, для «Параметров», но не для «Атрибутов». Я использую sphinx 2.0.1