1. Tay Ray Chuan
  2. sphinx


Tay Ray Chuan  committed ef99412

test_autodoc: add test for doc comment

Right now, the generated doc shows "Class to document.", instead of
"Class instance to document."

  • Participants
  • Parent commits dd46f48
  • Branches default

Comments (0)

Files changed (2)

File tests/root/autodoc.txt

View file
  • Ignore whitespace
    Additional content.
+.. autodata:: ClassInstance
 .. autoclass:: Outer
    :members: Inner

File tests/test_autodoc.py

View file
  • Ignore whitespace
         self.inst_attr_string = None
         """a documented instance attribute"""
+#: Class instance to document.
+ClassInstance = Class("an arg")
 class CustomDict(dict):