File tree 6 files changed +23
-32
lines changed
6 files changed +23
-32
lines changed Original file line number Diff line number Diff line change @@ -7,27 +7,18 @@ Document objects
7
7
The main Document and related objects.
8
8
9
9
10
- .. currentmodule :: docx.api
10
+ |Document | constructor
11
+ ----------------------
11
12
13
+ .. autofunction :: docx.Document
12
14
13
- |Document | objects
14
- ------------------
15
-
16
-
17
- .. autoclass :: Document
18
- :members:
19
- :exclude-members: numbering_part, styles_part
20
15
21
-
22
- .. currentmodule :: docx.parts.document
23
-
24
-
25
- |Sections | objects
16
+ |Document | objects
26
17
------------------
27
18
28
-
29
- .. autoclass :: Sections
19
+ .. autoclass :: docx.document.Document()
30
20
:members:
21
+ :exclude-members: styles_part
31
22
32
23
33
24
|CoreProperties | objects
Original file line number Diff line number Diff line change 1
1
2
2
.. _section_api :
3
3
4
+
4
5
Section objects
5
6
===============
6
7
7
8
Provides access to section properties such as margins and page orientation.
8
9
9
10
11
+ |Sections | objects
12
+ ------------------
13
+
10
14
.. currentmodule :: docx.section
11
15
16
+ .. autoclass :: Sections
17
+ :members:
18
+
12
19
13
20
|Section | objects
14
21
-----------------
Original file line number Diff line number Diff line change 4
4
Shape-related objects
5
5
=====================
6
6
7
- .. currentmodule :: docx.parts.document
7
+ .. currentmodule :: docx.shape
8
8
9
9
10
10
|InlineShapes | objects
11
11
----------------------
12
12
13
13
.. autoclass :: InlineShapes
14
14
:members:
15
-
16
-
17
- .. currentmodule :: docx.shape
15
+ :exclude-members: add_picture
18
16
19
17
20
18
|InlineShape | objects
Original file line number Diff line number Diff line change @@ -8,34 +8,26 @@ Text-related objects
8
8
|Paragraph | objects
9
9
-------------------
10
10
11
- .. currentmodule :: docx.text.paragraph
12
-
13
- .. autoclass :: Paragraph
11
+ .. autoclass :: docx.text.paragraph.Paragraph()
14
12
:members:
15
13
16
14
17
15
|ParagraphFormat | objects
18
16
-------------------------
19
17
20
- .. currentmodule :: docx.text.paragraph
21
-
22
- .. autoclass :: ParagraphFormat
18
+ .. autoclass :: docx.text.parfmt.ParagraphFormat()
23
19
:members:
24
20
25
21
26
22
|Run | objects
27
23
-------------
28
24
29
- .. currentmodule :: docx.text.run
30
-
31
- .. autoclass :: Run
25
+ .. autoclass :: docx.text.run.Run()
32
26
:members:
33
27
34
28
35
29
|Font | objects
36
30
--------------
37
31
38
- .. currentmodule :: docx.text.run
39
-
40
- .. autoclass :: Font
32
+ .. autoclass :: docx.text.run.Font()
41
33
:members:
Original file line number Diff line number Diff line change 91
91
92
92
.. |Document| replace:: :class:`.Document`
93
93
94
+ .. |DocumentPart| replace:: :class:`.DocumentPart`
95
+
94
96
.. |docx| replace:: ``python-docx``
95
97
96
98
.. |Emu| replace:: :class:`.Emu`
Original file line number Diff line number Diff line change 17
17
18
18
class Document (ElementProxy ):
19
19
"""
20
- WordprocessingML (WML) document.
20
+ WordprocessingML (WML) document. Not intended to be constructed directly.
21
+ Use :func:`docx.Document` to open or create a document.
21
22
"""
22
23
23
24
__slots__ = ('_part' , '__body' )
You can’t perform that action at this time.
0 commit comments