Skip to content

Commit 026009d

Browse files
author
Steve Canny
committed
docs: adjust API docs to reflect relocations
1 parent 705391d commit 026009d

File tree

6 files changed

+23
-32
lines changed

6 files changed

+23
-32
lines changed

docs/api/document.rst

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,18 @@ Document objects
77
The main Document and related objects.
88

99

10-
.. currentmodule:: docx.api
10+
|Document| constructor
11+
----------------------
1112

13+
.. autofunction:: docx.Document
1214

13-
|Document| objects
14-
------------------
15-
16-
17-
.. autoclass:: Document
18-
:members:
19-
:exclude-members: numbering_part, styles_part
2015

21-
22-
.. currentmodule:: docx.parts.document
23-
24-
25-
|Sections| objects
16+
|Document| objects
2617
------------------
2718

28-
29-
.. autoclass:: Sections
19+
.. autoclass:: docx.document.Document()
3020
:members:
21+
:exclude-members: styles_part
3122

3223

3324
|CoreProperties| objects

docs/api/section.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11

22
.. _section_api:
33

4+
45
Section objects
56
===============
67

78
Provides access to section properties such as margins and page orientation.
89

910

11+
|Sections| objects
12+
------------------
13+
1014
.. currentmodule:: docx.section
1115

16+
.. autoclass:: Sections
17+
:members:
18+
1219

1320
|Section| objects
1421
-----------------

docs/api/shape.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,15 @@
44
Shape-related objects
55
=====================
66

7-
.. currentmodule:: docx.parts.document
7+
.. currentmodule:: docx.shape
88

99

1010
|InlineShapes| objects
1111
----------------------
1212

1313
.. autoclass:: InlineShapes
1414
:members:
15-
16-
17-
.. currentmodule:: docx.shape
15+
:exclude-members: add_picture
1816

1917

2018
|InlineShape| objects

docs/api/text.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,26 @@ Text-related objects
88
|Paragraph| objects
99
-------------------
1010

11-
.. currentmodule:: docx.text.paragraph
12-
13-
.. autoclass:: Paragraph
11+
.. autoclass:: docx.text.paragraph.Paragraph()
1412
:members:
1513

1614

1715
|ParagraphFormat| objects
1816
-------------------------
1917

20-
.. currentmodule:: docx.text.paragraph
21-
22-
.. autoclass:: ParagraphFormat
18+
.. autoclass:: docx.text.parfmt.ParagraphFormat()
2319
:members:
2420

2521

2622
|Run| objects
2723
-------------
2824

29-
.. currentmodule:: docx.text.run
30-
31-
.. autoclass:: Run
25+
.. autoclass:: docx.text.run.Run()
3226
:members:
3327

3428

3529
|Font| objects
3630
--------------
3731

38-
.. currentmodule:: docx.text.run
39-
40-
.. autoclass:: Font
32+
.. autoclass:: docx.text.run.Font()
4133
:members:

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@
9191
9292
.. |Document| replace:: :class:`.Document`
9393
94+
.. |DocumentPart| replace:: :class:`.DocumentPart`
95+
9496
.. |docx| replace:: ``python-docx``
9597
9698
.. |Emu| replace:: :class:`.Emu`

docx/document.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717

1818
class Document(ElementProxy):
1919
"""
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.
2122
"""
2223

2324
__slots__ = ('_part', '__body')

0 commit comments

Comments
 (0)