Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4fbe1f6

Browse files
committed
docs: add Comments docs
- developer/analysis docs - user docs - API docs
1 parent a809d6c commit 4fbe1f6

File tree

12 files changed

+846
-125
lines changed

12 files changed

+846
-125
lines changed

docs/_static/img/comment-parts.png

29.4 KB
Loading

docs/api/comments.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
.. _comments_api:
3+
4+
Comment-related objects
5+
=======================
6+
7+
.. currentmodule:: docx.comments
8+
9+
10+
|Comments| objects
11+
------------------
12+
13+
.. autoclass:: Comments()
14+
:members:
15+
:inherited-members:
16+
:exclude-members:
17+
part
18+
19+
20+
|Comment| objects
21+
------------------
22+
23+
.. autoclass:: Comment()
24+
:members:
25+
:inherited-members:
26+
:exclude-members:
27+
part

docs/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,6 @@
8383
8484
.. |CharacterStyle| replace:: :class:`.CharacterStyle`
8585
86-
.. |Comments| replace:: :class:`.Comments`
87-
8886
.. |Cm| replace:: :class:`.Cm`
8987
9088
.. |ColorFormat| replace:: :class:`.ColorFormat`
@@ -93,6 +91,10 @@
9391
9492
.. |_Columns| replace:: :class:`._Columns`
9593
94+
.. |Comment| replace:: :class:`.Comment`
95+
96+
.. |Comments| replace:: :class:`.Comments`
97+
9698
.. |CoreProperties| replace:: :class:`.CoreProperties`
9799
98100
.. |datetime| replace:: :class:`.datetime.datetime`

0 commit comments

Comments
 (0)