docs: add API documentation for latent styles

Steve Canny · Steve Canny · commit 3eb7d1eac697 · 2015-02-08T00:01:47.000-08:00
* also add API for Styles objects
diff --git a/docs/api/style.rst b/docs/api/style.rst
@@ -10,12 +10,24 @@ formatting consistency thoroughout a document and across related documents
 and allows formatting changes to be made globally by changing the definition
 in the appropriate style.
 
-.. currentmodule:: docx.styles.style
+
+|Styles| objects
+----------------
+
+.. currentmodule:: docx.styles.styles
+
+.. autoclass:: Styles()
+   :members:
+   :inherited-members:
+   :exclude-members:
+       get_by_id, get_style_id, part
 
 
 |BaseStyle| objects
 -------------------
 
+.. currentmodule:: docx.styles.style
+
 .. autoclass:: BaseStyle()
    :members:
    :inherited-members:
@@ -61,3 +73,25 @@ in the appropriate style.
 
 .. autoclass:: _NumberingStyle()
    :members:
+
+
+|LatentStyles| objects
+----------------------
+
+.. currentmodule:: docx.styles.latent
+
+.. autoclass:: LatentStyles()
+   :members:
+   :inherited-members:
+   :exclude-members:
+       part
+
+
+|_LatentStyle| objects
+----------------------
+
+.. autoclass:: _LatentStyle()
+   :members:
+   :inherited-members:
+   :exclude-members:
+       part
diff --git a/docs/conf.py b/docs/conf.py
@@ -149,8 +149,6 @@
 
 .. |str| replace:: :class:`.str`
 
-.. |Style| replace:: :class:`.Style`
-
 .. |Styles| replace:: :class:`.Styles`
 
 .. |StylesPart| replace:: :class:`.StylesPart`
diff --git a/docs/user/styles-using.rst b/docs/user/styles-using.rst
@@ -36,7 +36,7 @@ name::
    are accessed with the name exactly as it appears in the Word UI.
 
 The |Styles| object is also iterable. By using the identification properties
-on |Style|, various subsets of the defined styles can be generated. For
+on |BaseStyle|, various subsets of the defined styles can be generated. For
 example, this code will produce a list of the defined paragraph styles::
 
    >>> from docx.enum.style import WD_STYLE_TYPE
@@ -56,7 +56,7 @@ Apply a style
 -------------
 
 The |Paragraph|, |Run|, and |Table| objects each have a :attr:`style`
-attribute. Assigning a |Style| object to this attribute applies that style::
+attribute. Assigning a style object to this attribute applies that style::
 
     >>> document = Document()
     >>> paragraph = document.add_paragraph()
@@ -77,8 +77,8 @@ lookup for you::
     >>> paragraph.style.name
     'List Bullet'
 
-A style can also be applied at creation time using either the |Style| object
-or its name::
+A style can also be applied at creation time using either the style object or
+its name::
 
     >>> paragraph = document.add_paragraph(style='Body Text')
     >>> paragraph.style.name
diff --git a/docx/styles/styles.py b/docx/styles/styles.py
@@ -15,9 +15,9 @@
 
 class Styles(ElementProxy):
     """
-    A collection of |Style| objects defined in a document. Supports
-    ``len()``, iteration, and dictionary-style access by style id and style
-    UI name.
+    A collection providing access to the styles defined in a document.
+    Accessed using the :attr:`.Document.styles` property. Supports ``len()``,
+    iteration, and dictionary-style access by style name.
     """
 
     __slots__ = ()
