From d9e3a5c4c939b3a26755dc7e48baed0834fee3a0 Mon Sep 17 00:00:00 2001 From: Andrew Berezovskyi Date: Fri, 30 Jun 2017 20:41:51 +0200 Subject: [PATCH] Regenerate the docs sphinx-apidoc -f -o docs trello Signed-off-by: Andrew Berezovskyi --- docs/conf.py | 5 +- docs/modules.rst | 7 +++ docs/trello.rst | 118 ++++++++++++++++++++++++++++++++++++++++++++--- 3 files changed, 121 insertions(+), 9 deletions(-) create mode 100644 docs/modules.rst diff --git a/docs/conf.py b/docs/conf.py index 638f1db1..3c7f1373 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # 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. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../')) # -- General configuration ------------------------------------------------ @@ -116,7 +116,8 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'alabaster' +# html_theme = 'alabaster' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 00000000..2f860f3d --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +trello +====== + +.. toctree:: + :maxdepth: 4 + + trello diff --git a/docs/trello.rst b/docs/trello.rst index 3f1abd34..b750f8b9 100644 --- a/docs/trello.rst +++ b/docs/trello.rst @@ -1,22 +1,126 @@ trello package ============== -Module contents ---------------- +Submodules +---------- -.. automodule:: trello +trello\.attachments module +-------------------------- + +.. automodule:: trello.attachments :members: :undoc-members: :show-inheritance: -Submodules ----------- +trello\.base module +------------------- + +.. automodule:: trello.base + :members: + :undoc-members: + :show-inheritance: + +trello\.board module +-------------------- + +.. automodule:: trello.board + :members: + :undoc-members: + :show-inheritance: + +trello\.card module +------------------- + +.. automodule:: trello.card + :members: + :undoc-members: + :show-inheritance: + +trello\.checklist module +------------------------ + +.. automodule:: trello.checklist + :members: + :undoc-members: + :show-inheritance: -trello.util module ------------------- +trello\.compat module +--------------------- + +.. automodule:: trello.compat + :members: + :undoc-members: + :show-inheritance: + +trello\.exceptions module +------------------------- + +.. automodule:: trello.exceptions + :members: + :undoc-members: + :show-inheritance: + +trello\.label module +-------------------- + +.. automodule:: trello.label + :members: + :undoc-members: + :show-inheritance: + +trello\.member module +--------------------- + +.. automodule:: trello.member + :members: + :undoc-members: + :show-inheritance: + +trello\.organization module +--------------------------- + +.. automodule:: trello.organization + :members: + :undoc-members: + :show-inheritance: + +trello\.trelloclient module +--------------------------- + +.. automodule:: trello.trelloclient + :members: + :undoc-members: + :show-inheritance: + +trello\.trellolist module +------------------------- + +.. automodule:: trello.trellolist + :members: + :undoc-members: + :show-inheritance: + +trello\.util module +------------------- .. automodule:: trello.util :members: :undoc-members: :show-inheritance: +trello\.webhook module +---------------------- + +.. automodule:: trello.webhook + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: trello + :members: + :undoc-members: + :show-inheritance: