Skip to content

Commit 3e1944a

Browse files
committed
Docs: add some classes missing from API section
1 parent 8530987 commit 3e1944a

File tree

4 files changed

+35
-10
lines changed

4 files changed

+35
-10
lines changed

doc/api/structure.rst

+26-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,21 @@ Lists
2323
.. autoclass:: List
2424
:members:
2525

26+
.. autoclass:: ListStyle
27+
:members:
28+
29+
.. autoclass:: ListItem
30+
:members:
31+
32+
.. autoclass:: ListItemStyle
33+
:members:
34+
35+
.. autoclass:: ListItemLabel
36+
:members:
37+
38+
.. autoclass:: ListItemLabelStyle
39+
:members:
40+
2641
.. autoclass:: DefinitionList
2742
:members:
2843

@@ -40,7 +55,17 @@ Table of Contents
4055
:members:
4156

4257

43-
Adminitions
58+
List of ...
59+
~~~~~~~~~~~
60+
61+
.. autoclass:: ListOfStyle
62+
:members:
63+
64+
.. autoclass:: ListOfEntryStyle
65+
:members:
66+
67+
68+
Admonitions
4469
~~~~~~~~~~~
4570

4671
.. autoclass:: Admonition

src/rinoh/reference.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
MixedStyledTextBase, MixedStyledText, ErrorText)
2323
from .util import NotImplementedAttribute
2424

25-
__all__ = ['Reference', 'ReferenceField', 'ReferenceText', 'ReferenceType',
26-
'ReferencingParagraph', 'ReferencingParagraphStyle',
27-
'Note', 'NoteMarkerBase', 'NoteMarkerByID', 'NoteMarkerWithNote',
28-
'NoteMarkerStyle', 'Field',
25+
__all__ = ['Reference', 'ReferenceStyle', 'ReferenceField', 'ReferenceText',
26+
'ReferenceType', 'ReferencingParagraph', 'ReferencingParagraphStyle',
27+
'Note', 'NoteStyle', 'NoteMarkerBase', 'NoteMarkerByID',
28+
'NoteMarkerWithNote', 'NoteMarkerStyle', 'Field',
2929
'PAGE_NUMBER', 'NUMBER_OF_PAGES', 'SECTION_NUMBER',
3030
'SECTION_TITLE', 'DOCUMENT_TITLE', 'DOCUMENT_SUBTITLE']
3131

src/rinoh/structure.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
from .strings import StringField
2626
from .util import NotImplementedAttribute, itemcount
2727

28-
__all__ = ['Section', 'Heading',
29-
'ListStyle', 'List', 'ListItem', 'ListItemLabel', 'DefinitionList',
28+
__all__ = ['Section', 'Heading', 'ListStyle', 'List', 'ListItem',
29+
'ListItemLabel', 'ListItemLabelStyle', 'DefinitionList',
3030
'Header', 'Footer',
31-
'TableOfContentsSection', 'TableOfContentsStyle', 'TableOfContents',
32-
'ListOfStyle',
31+
'TableOfContentsSection', 'TableOfContents', 'TableOfContentsStyle',
32+
'ListOfStyle', 'ListOfEntry', 'ListOfEntryStyle',
3333
'TableOfContentsEntry', 'Admonition', 'AdmonitionStyle',
3434
'AdmonitionTitleParagraph',
3535
'HorizontalRule', 'HorizontalRuleStyle', 'OutOfLineFlowables']

src/rinoh/table.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from .util import ReadAliasAttribute, INF
2626

2727

28-
__all__ = ['Table', 'TableStyle', 'TableWithCaption',
28+
__all__ = ['Table', 'TableStyle', 'TableWithCaption', 'TableWithCaptionStyle',
2929
'TableSection', 'TableHead', 'TableBody', 'TableRow',
3030
'TableCell', 'TableCellStyle',
3131
'TableCellBorder', 'TableCellBorderStyle',

0 commit comments

Comments
 (0)