Skip to content

Commit dd44e1f

Browse files
author
Steve Canny
committed
docs: add API docs for ColorFormat
1 parent a51022b commit dd44e1f

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

docs/api/dml.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
.. _dml_api:
3+
4+
DrawingML objects
5+
=================
6+
7+
Low-level drawing elements like color that appear in various document
8+
contexts.
9+
10+
11+
|ColorFormat| objects
12+
---------------------
13+
14+
.. autoclass:: docx.dml.color.ColorFormat()
15+
:members:
16+
:undoc-members:

docs/api/shared.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,17 @@ allowing values to be expressed in the units most appropriate to the context.
4343

4444
.. autoclass:: Emu
4545
:members:
46+
47+
48+
|RGBColor| objects
49+
------------------
50+
51+
.. autoclass:: RGBColor(r, g, b)
52+
:members:
53+
:undoc-members:
54+
55+
*r*, *g*, and *b* are each an integer in the range 0-255 inclusive. Using
56+
the hexidecimal integer notation, e.g. `0x42` may enhance readability
57+
where hex RGB values are in use::
58+
59+
>>> lavender = RGBColor(0xff, 0x99, 0xcc)

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ API Documentation
8888
api/table
8989
api/section
9090
api/shape
91+
api/dml
9192
api/shared
9293
api/enum/index
9394

0 commit comments

Comments
 (0)