Skip to content

Commit

Permalink
Fix conf.py (sphinx-build) (#179)
Browse files Browse the repository at this point in the history
* Fix conf.py to generate document properly

* update conf.py and .rst files

* modify .rst to hide unnecessary function and module in document
  • Loading branch information
okue committed Jun 18, 2019
1 parent 4d1d425 commit 4a8a2a5
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 62 deletions.
15 changes: 10 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -341,6 +341,11 @@
# texinfo_no_detailmenu = False

# enable __init__ method
autoclass_content = 'both'

autoclass_content = 'class'
autodoc_default_options = {
'special-members': '__init__',
'members': True,
'undoc-members': True,
'show-inheritance': True
}
autodoc_member_order = 'bysource'
38 changes: 1 addition & 37 deletions docs/source/linebot.models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,94 +5,58 @@ linebot.models.actions module
--------------------------

.. automodule:: linebot.models.actions
:members:
:undoc-members:
:show-inheritance:

linebot.models.base module
--------------------------

.. automodule:: linebot.models.base
:members:
:undoc-members:
:show-inheritance:

linebot.models.error module
---------------------------

.. automodule:: linebot.models.error
:members:
:undoc-members:
:show-inheritance:

linebot.models.events module
----------------------------

.. automodule:: linebot.models.events
:members:
:undoc-members:
:show-inheritance:

linebot.models.imagemap module
------------------------------

.. automodule:: linebot.models.imagemap
:members:
:undoc-members:
:show-inheritance:

linebot.models.messages module
------------------------------

.. automodule:: linebot.models.messages
:members:
:undoc-members:
:show-inheritance:

linebot.models.responses module
-------------------------------

.. automodule:: linebot.models.responses
:members:
:undoc-members:
:show-inheritance:

linebot.models.rich_menu module
-------------------------------

.. automodule:: linebot.models.rich_menu
:members:
:undoc-members:
:show-inheritance:

linebot.models.send_messages module
-----------------------------------

.. automodule:: linebot.models.send_messages
:members:
:undoc-members:
:show-inheritance:

linebot.models.sources module
-----------------------------

.. automodule:: linebot.models.sources
:members:
:undoc-members:
:show-inheritance:

linebot.models.template module
------------------------------

.. automodule:: linebot.models.template
:members:
:undoc-members:
:show-inheritance:

linebot.models.things module
------------------------------

.. automodule:: linebot.models.things
:members:
:undoc-members:
:show-inheritance:
.. automodule:: linebot.models.things
21 changes: 1 addition & 20 deletions docs/source/linebot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,22 @@ linebot.api module
------------------

.. automodule:: linebot.api
:members:
:undoc-members:
:show-inheritance:

linebot.webhook module
----------------------

.. automodule:: linebot.webhook
:members:
:undoc-members:
:show-inheritance:
:exclude-members: compare_digest

linebot.exceptions module
-------------------------

.. automodule:: linebot.exceptions
:members:
:undoc-members:
:show-inheritance:

linebot.http_client module
--------------------------

.. automodule:: linebot.http_client
:members:
:undoc-members:
:show-inheritance:

linebot.utils module
--------------------

.. automodule:: linebot.utils
:members:
:undoc-members:
:show-inheritance:

Subpackages
-----------
Expand Down

0 comments on commit 4a8a2a5

Please sign in to comment.