Skip to content

Commit bb70714

Browse files
author
Steve Canny
committed
docs: update API documentation for Slides
1 parent f10ccc4 commit bb70714

5 files changed

Lines changed: 10 additions & 29 deletions

File tree

‎docs/api/slides.rst‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,20 @@ is not intended to be constructed directly.
1919
|Slide| objects
2020
---------------
2121

22-
|Slide| objects are accessed by index from ``prs.slides`` or as a return value
23-
from ``slides.add_slide()``.
22+
An individual |Slide| object is accessed by index from |Slides| or as the
23+
return value of :meth:`add_slide`.
2424

25-
.. autoclass:: pptx.parts.slide.Slide()
25+
.. autoclass:: pptx.slide.Slide()
2626
:members:
27-
:exclude-members:
28-
add_chart_part, after_unmarshal, before_marshal, blob, content_type,
29-
drop_rel, get_image, get_or_add_image_part, load, load_rel, new,
30-
package, part, part_related_by, relate_to, related_parts, rels,
31-
spTree, target_ref
27+
:exclude-members: part
3228
:inherited-members:
3329
:undoc-members:
3430

3531

3632
|SlideLayout| objects
3733
---------------------
3834

39-
.. autoclass:: pptx.parts.slidelayout.SlideLayoutPart
35+
.. autoclass:: pptx.slide.SlideLayout
4036
:members:
4137
:exclude-members: iter_cloneable_placeholders
4238

@@ -46,7 +42,7 @@ from ``slides.add_slide()``.
4642

4743
.. autoclass:: pptx.parts.slidemaster.SlideMasterPart
4844
:members:
49-
:exclude-members: sldLayoutIdLst
45+
:exclude-members: related_slide_layout, sldLayoutIdLst
5046

5147

5248
|SlidePlaceholders| objects

‎docs/conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,12 @@ def _warn_node(self, msg, node):
259259
260260
.. |SlideLayout| replace:: :class:`.SlideLayout`
261261
262+
.. |SlideLayoutPart| replace:: :class:`.SlideLayoutPart`
263+
262264
.. |SlideMaster| replace:: :class:`.SlideMaster`
263265
266+
.. |SlideMasterPart| replace:: :class:`.SlideMasterPart`
267+
264268
.. |SlidePlaceholders| replace:: :class:`.SlidePlaceholders`
265269
266270
.. |SlideShapeTree| replace:: :class:`.SlideShapeTree`

‎pptx/parts/slide.py‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,6 @@ def name(self):
4848
"""
4949
return self._element.cSld.name
5050

51-
@property
52-
def spTree(self):
53-
"""
54-
Reference to ``<p:spTree>`` element for this slide
55-
"""
56-
return self._element.cSld.spTree
57-
5851

5952
class SlidePart(BaseSlidePart):
6053
"""

‎pptx/slide.py‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,6 @@ def slide_layout(self):
4949
"""
5050
return self.part.slide_layout
5151

52-
@property
53-
def spTree(self):
54-
"""
55-
Reference to ``<p:spTree>`` element for this slide
56-
"""
57-
return self._element.cSld.spTree
58-
5952

6053
class Slides(ParentedElementProxy):
6154
"""

‎tests/parts/test_slide.py‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,6 @@ def it_can_add_an_image_part(self, image_part_fixture):
5151
assert image_part is image_part_
5252
assert rId is rId_
5353

54-
def it_provides_access_to_its_spTree_element_to_help(self):
55-
slide = BaseSlidePart(None, None, element('p:sld/p:cSld/p:spTree'))
56-
spTree = slide.spTree
57-
assert spTree is slide._element.xpath('//p:spTree')[0]
58-
5954
# fixtures -------------------------------------------------------
6055

6156
@pytest.fixture

0 commit comments

Comments
 (0)