Skip to content

Commit 4a8a2a5

Browse files
authored
Fix conf.py (sphinx-build) (#179)
* Fix conf.py to generate document properly * update conf.py and .rst files * modify .rst to hide unnecessary function and module in document
1 parent 4d1d425 commit 4a8a2a5

File tree

3 files changed

+12
-62
lines changed

3 files changed

+12
-62
lines changed

docs/source/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
# add these directories to sys.path here. If the directory is relative to the
1717
# documentation root, use os.path.abspath to make it absolute, like shown here.
1818
#
19-
# import os
20-
# import sys
21-
# sys.path.insert(0, os.path.abspath('.'))
19+
import os
20+
import sys
21+
sys.path.insert(0, os.path.abspath('../../'))
2222

2323
# -- General configuration ------------------------------------------------
2424

@@ -341,6 +341,11 @@
341341
# texinfo_no_detailmenu = False
342342

343343
# enable __init__ method
344-
autoclass_content = 'both'
345-
344+
autoclass_content = 'class'
345+
autodoc_default_options = {
346+
'special-members': '__init__',
347+
'members': True,
348+
'undoc-members': True,
349+
'show-inheritance': True
350+
}
346351
autodoc_member_order = 'bysource'

docs/source/linebot.models.rst

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,94 +5,58 @@ linebot.models.actions module
55
--------------------------
66

77
.. automodule:: linebot.models.actions
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
118

129
linebot.models.base module
1310
--------------------------
1411

1512
.. automodule:: linebot.models.base
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
1913

2014
linebot.models.error module
2115
---------------------------
2216

2317
.. automodule:: linebot.models.error
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
2718

2819
linebot.models.events module
2920
----------------------------
3021

3122
.. automodule:: linebot.models.events
32-
:members:
33-
:undoc-members:
34-
:show-inheritance:
3523

3624
linebot.models.imagemap module
3725
------------------------------
3826

3927
.. automodule:: linebot.models.imagemap
40-
:members:
41-
:undoc-members:
42-
:show-inheritance:
4328

4429
linebot.models.messages module
4530
------------------------------
4631

4732
.. automodule:: linebot.models.messages
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:
5133

5234
linebot.models.responses module
5335
-------------------------------
5436

5537
.. automodule:: linebot.models.responses
56-
:members:
57-
:undoc-members:
58-
:show-inheritance:
5938

6039
linebot.models.rich_menu module
6140
-------------------------------
6241

6342
.. automodule:: linebot.models.rich_menu
64-
:members:
65-
:undoc-members:
66-
:show-inheritance:
6743

6844
linebot.models.send_messages module
6945
-----------------------------------
7046

7147
.. automodule:: linebot.models.send_messages
72-
:members:
73-
:undoc-members:
74-
:show-inheritance:
7548

7649
linebot.models.sources module
7750
-----------------------------
7851

7952
.. automodule:: linebot.models.sources
80-
:members:
81-
:undoc-members:
82-
:show-inheritance:
8353

8454
linebot.models.template module
8555
------------------------------
8656

8757
.. automodule:: linebot.models.template
88-
:members:
89-
:undoc-members:
90-
:show-inheritance:
9158

9259
linebot.models.things module
9360
------------------------------
9461

95-
.. automodule:: linebot.models.things
96-
:members:
97-
:undoc-members:
98-
:show-inheritance:
62+
.. automodule:: linebot.models.things

docs/source/linebot.rst

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,22 @@ linebot.api module
55
------------------
66

77
.. automodule:: linebot.api
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
118

129
linebot.webhook module
1310
----------------------
1411

1512
.. automodule:: linebot.webhook
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
13+
:exclude-members: compare_digest
1914

2015
linebot.exceptions module
2116
-------------------------
2217

2318
.. automodule:: linebot.exceptions
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
2719

2820
linebot.http_client module
2921
--------------------------
3022

3123
.. automodule:: linebot.http_client
32-
:members:
33-
:undoc-members:
34-
:show-inheritance:
35-
36-
linebot.utils module
37-
--------------------
38-
39-
.. automodule:: linebot.utils
40-
:members:
41-
:undoc-members:
42-
:show-inheritance:
4324

4425
Subpackages
4526
-----------

0 commit comments

Comments
 (0)