Add API documentation

docs/_templates/module.rst

@@ -0,0 +1,25 @@
+{{ fullname | escape | underline }}
+===================================
+
+.. currentmodule:: {{ module }}
+
+.. automodule:: {{ fullname }}
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   {% for item in functions %}
+   {{ item }}
+   {% endfor %}
+
+   {% for item in classes %}
+   {{ item }}
+   {% endfor %}
+
+.. automodule:: {{ fullname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/api.rst

@@ -0,0 +1,18 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: generated/
+   :template: module.rst
+   :nosignatures:
+   :caption: Core Modules and Classes
+
+   slidedeckai.cli
+   slidedeckai.core
+   slidedeckai.helpers.chat_helper
+   slidedeckai.helpers.file_manager
+   slidedeckai.helpers.icons_embeddings
+   slidedeckai.helpers.image_search
+   slidedeckai.helpers.llm_helper
+   slidedeckai.helpers.pptx_helper
+   slidedeckai.helpers.text_helper

docs/conf.py

@@ -0,0 +1,50 @@
+"""
+Sphinx configuration file for the KodeAgent documentation.
+This file sets up Sphinx to generate documentation from the source code
+located in the 'src' directory, and includes support for Markdown files
+using the MyST parser.
+"""
+import os
+import sys
+
+# --- Path setup ---
+# Crucial: This tells Sphinx to look in 'src' to find the 'kodeagent' package.
+sys.path.insert(0, os.path.abspath('../src'))
+
+# --- Project information ---
+project = 'SlideDeck AI'
+copyright = '2025, Barun Saha'
+author = 'Barun Saha'
+
+# --- General configuration ---
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',    # Converts Google/NumPy style docstrings
+    'sphinx.ext.viewcode',
+    'myst_parser',            # Enables Markdown support (.md files)
+]
+autosummary_generate = True
+
+# --- Autodoc configuration for sorting ---
+autodoc_member_order = 'alphabetical'
+
+# Tell Sphinx to look for custom templates
+templates_path = ['_templates']
+
+# Configure MyST to allow cross-referencing and nested structure
+myst_enable_extensions = [
+    'deflist',
+    'html_image',
+    'linkify',
+    'replacements',
+    'html_admonition'
+]
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+html_theme = 'pydata_sphinx_theme'
+master_doc = 'index'
+html_show_sourcelink = True

docs/generated/slidedeckai.cli.CustomArgumentParser.rst

@@ -0,0 +1,40 @@
+slidedeckai.cli.CustomArgumentParser
+====================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autoclass:: CustomArgumentParser
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~CustomArgumentParser.__init__
+      ~CustomArgumentParser.add_argument
+      ~CustomArgumentParser.add_argument_group
+      ~CustomArgumentParser.add_mutually_exclusive_group
+      ~CustomArgumentParser.add_subparsers
+      ~CustomArgumentParser.convert_arg_line_to_args
+      ~CustomArgumentParser.error
+      ~CustomArgumentParser.exit
+      ~CustomArgumentParser.format_help
+      ~CustomArgumentParser.format_usage
+      ~CustomArgumentParser.get_default
+      ~CustomArgumentParser.parse_args
+      ~CustomArgumentParser.parse_intermixed_args
+      ~CustomArgumentParser.parse_known_args
+      ~CustomArgumentParser.parse_known_intermixed_args
+      ~CustomArgumentParser.print_help
+      ~CustomArgumentParser.print_usage
+      ~CustomArgumentParser.register
+      ~CustomArgumentParser.set_defaults
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.cli.CustomHelpFormatter.rst

@@ -0,0 +1,29 @@
+slidedeckai.cli.CustomHelpFormatter
+===================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autoclass:: CustomHelpFormatter
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~CustomHelpFormatter.__init__
+      ~CustomHelpFormatter.add_argument
+      ~CustomHelpFormatter.add_arguments
+      ~CustomHelpFormatter.add_text
+      ~CustomHelpFormatter.add_usage
+      ~CustomHelpFormatter.end_section
+      ~CustomHelpFormatter.format_help
+      ~CustomHelpFormatter.start_section
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.cli.format_model_help.rst

@@ -0,0 +1,6 @@
+slidedeckai.cli.format\_model\_help
+===================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autofunction:: format_model_help

docs/generated/slidedeckai.cli.format_models_as_bullets.rst

@@ -0,0 +1,6 @@
+slidedeckai.cli.format\_models\_as\_bullets
+===========================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autofunction:: format_models_as_bullets

docs/generated/slidedeckai.cli.format_models_list.rst

@@ -0,0 +1,6 @@
+slidedeckai.cli.format\_models\_list
+====================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autofunction:: format_models_list

docs/generated/slidedeckai.cli.group_models_by_provider.rst

@@ -0,0 +1,6 @@
+slidedeckai.cli.group\_models\_by\_provider
+===========================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autofunction:: group_models_by_provider

docs/generated/slidedeckai.cli.main.rst

@@ -0,0 +1,6 @@
+slidedeckai.cli.main
+====================
+
+.. currentmodule:: slidedeckai.cli
+
+.. autofunction:: main

docs/generated/slidedeckai.cli.rst

@@ -0,0 +1,36 @@
+slidedeckai.cli
+===============
+===================================
+
+.. currentmodule:: slidedeckai.cli
+
+.. automodule:: slidedeckai.cli
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   format_model_help
+   
+   format_models_as_bullets
+   
+   format_models_list
+   
+   group_models_by_provider
+   
+   main
+   
+
+   
+   CustomArgumentParser
+   
+   CustomHelpFormatter
+   
+
+.. automodule:: slidedeckai.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.core.SlideDeckAI.rst

@@ -0,0 +1,26 @@
+slidedeckai.core.SlideDeckAI
+============================
+
+.. currentmodule:: slidedeckai.core
+
+.. autoclass:: SlideDeckAI
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~SlideDeckAI.__init__
+      ~SlideDeckAI.generate
+      ~SlideDeckAI.reset
+      ~SlideDeckAI.revise
+      ~SlideDeckAI.set_template
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.core.rst

@@ -0,0 +1,24 @@
+slidedeckai.core
+================
+===================================
+
+.. currentmodule:: slidedeckai
+
+.. automodule:: slidedeckai.core
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+
+   
+   SlideDeckAI
+   
+
+.. automodule:: slidedeckai.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.chat_helper.AIMessage.rst

@@ -0,0 +1,22 @@
+slidedeckai.helpers.chat\_helper.AIMessage
+==========================================
+
+.. currentmodule:: slidedeckai.helpers.chat_helper
+
+.. autoclass:: AIMessage
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~AIMessage.__init__
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.helpers.chat_helper.ChatMessage.rst

@@ -0,0 +1,22 @@
+slidedeckai.helpers.chat\_helper.ChatMessage
+============================================
+
+.. currentmodule:: slidedeckai.helpers.chat_helper
+
+.. autoclass:: ChatMessage
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~ChatMessage.__init__
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.helpers.chat_helper.ChatMessageHistory.rst

@@ -0,0 +1,24 @@
+slidedeckai.helpers.chat\_helper.ChatMessageHistory
+===================================================
+
+.. currentmodule:: slidedeckai.helpers.chat_helper
+
+.. autoclass:: ChatMessageHistory
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~ChatMessageHistory.__init__
+      ~ChatMessageHistory.add_ai_message
+      ~ChatMessageHistory.add_user_message
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.helpers.chat_helper.ChatPromptTemplate.rst

@@ -0,0 +1,24 @@
+slidedeckai.helpers.chat\_helper.ChatPromptTemplate
+===================================================
+
+.. currentmodule:: slidedeckai.helpers.chat_helper
+
+.. autoclass:: ChatPromptTemplate
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~ChatPromptTemplate.__init__
+      ~ChatPromptTemplate.format
+      ~ChatPromptTemplate.from_template
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.helpers.chat_helper.HumanMessage.rst

@@ -0,0 +1,22 @@
+slidedeckai.helpers.chat\_helper.HumanMessage
+=============================================
+
+.. currentmodule:: slidedeckai.helpers.chat_helper
+
+.. autoclass:: HumanMessage
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~HumanMessage.__init__
+   
+   
+
+   
+   
+   

docs/generated/slidedeckai.helpers.chat_helper.rst

@@ -0,0 +1,32 @@
+slidedeckai.helpers.chat\_helper
+================================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.chat_helper
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+
+   
+   AIMessage
+   
+   ChatMessage
+   
+   ChatMessageHistory
+   
+   ChatPromptTemplate
+   
+   HumanMessage
+   
+
+.. automodule:: slidedeckai.helpers.chat_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.file_manager.get_pdf_contents.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.file\_manager.get\_pdf\_contents
+====================================================
+
+.. currentmodule:: slidedeckai.helpers.file_manager
+
+.. autofunction:: get_pdf_contents

docs/generated/slidedeckai.helpers.file_manager.rst

@@ -0,0 +1,26 @@
+slidedeckai.helpers.file\_manager
+=================================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.file_manager
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   get_pdf_contents
+   
+   validate_page_range
+   
+
+   
+
+.. automodule:: slidedeckai.helpers.file_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.file_manager.validate_page_range.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.file\_manager.validate\_page\_range
+=======================================================
+
+.. currentmodule:: slidedeckai.helpers.file_manager
+
+.. autofunction:: validate_page_range

docs/generated/slidedeckai.helpers.icons_embeddings.find_icons.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.find\_icons
+=================================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: find_icons

docs/generated/slidedeckai.helpers.icons_embeddings.get_embeddings.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.get\_embeddings
+=====================================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: get_embeddings

docs/generated/slidedeckai.helpers.icons_embeddings.get_icons_list.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.get\_icons\_list
+======================================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: get_icons_list

docs/generated/slidedeckai.helpers.icons_embeddings.load_saved_embeddings.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.load\_saved\_embeddings
+=============================================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: load_saved_embeddings

docs/generated/slidedeckai.helpers.icons_embeddings.main.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.main
+==========================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: main

docs/generated/slidedeckai.helpers.icons_embeddings.rst

@@ -0,0 +1,34 @@
+slidedeckai.helpers.icons\_embeddings
+=====================================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.icons_embeddings
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   find_icons
+   
+   get_embeddings
+   
+   get_icons_list
+   
+   load_saved_embeddings
+   
+   main
+   
+   save_icons_embeddings
+   
+
+   
+
+.. automodule:: slidedeckai.helpers.icons_embeddings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.icons_embeddings.save_icons_embeddings.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.icons\_embeddings.save\_icons\_embeddings
+=============================================================
+
+.. currentmodule:: slidedeckai.helpers.icons_embeddings
+
+.. autofunction:: save_icons_embeddings

docs/generated/slidedeckai.helpers.image_search.extract_dimensions.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.image\_search.extract\_dimensions
+=====================================================
+
+.. currentmodule:: slidedeckai.helpers.image_search
+
+.. autofunction:: extract_dimensions

docs/generated/slidedeckai.helpers.image_search.get_image_from_url.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.image\_search.get\_image\_from\_url
+=======================================================
+
+.. currentmodule:: slidedeckai.helpers.image_search
+
+.. autofunction:: get_image_from_url

docs/generated/slidedeckai.helpers.image_search.get_photo_url_from_api_response.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.image\_search.get\_photo\_url\_from\_api\_response
+======================================================================
+
+.. currentmodule:: slidedeckai.helpers.image_search
+
+.. autofunction:: get_photo_url_from_api_response

docs/generated/slidedeckai.helpers.image_search.rst

@@ -0,0 +1,30 @@
+slidedeckai.helpers.image\_search
+=================================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.image_search
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   extract_dimensions
+   
+   get_image_from_url
+   
+   get_photo_url_from_api_response
+   
+   search_pexels
+   
+
+   
+
+.. automodule:: slidedeckai.helpers.image_search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.image_search.search_pexels.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.image\_search.search\_pexels
+================================================
+
+.. currentmodule:: slidedeckai.helpers.image_search
+
+.. autofunction:: search_pexels

docs/generated/slidedeckai.helpers.llm_helper.get_langchain_llm.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.get\_langchain\_llm
+===================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: get_langchain_llm

docs/generated/slidedeckai.helpers.llm_helper.get_litellm_llm.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.get\_litellm\_llm
+=================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: get_litellm_llm

docs/generated/slidedeckai.helpers.llm_helper.get_litellm_model_name.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.get\_litellm\_model\_name
+=========================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: get_litellm_model_name

docs/generated/slidedeckai.helpers.llm_helper.get_provider_model.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.get\_provider\_model
+====================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: get_provider_model

docs/generated/slidedeckai.helpers.llm_helper.is_valid_llm_provider_model.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.is\_valid\_llm\_provider\_model
+===============================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: is_valid_llm_provider_model

docs/generated/slidedeckai.helpers.llm_helper.rst

@@ -0,0 +1,34 @@
+slidedeckai.helpers.llm\_helper
+===============================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.llm_helper
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   get_langchain_llm
+   
+   get_litellm_llm
+   
+   get_litellm_model_name
+   
+   get_provider_model
+   
+   is_valid_llm_provider_model
+   
+   stream_litellm_completion
+   
+
+   
+
+.. automodule:: slidedeckai.helpers.llm_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.llm_helper.stream_litellm_completion.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.llm\_helper.stream\_litellm\_completion
+===========================================================
+
+.. currentmodule:: slidedeckai.helpers.llm_helper
+
+.. autofunction:: stream_litellm_completion

docs/generated/slidedeckai.helpers.pptx_helper.add_bulleted_items.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.add\_bulleted\_items
+=====================================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: add_bulleted_items

docs/generated/slidedeckai.helpers.pptx_helper.format_text.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.format\_text
+=============================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: format_text

docs/generated/slidedeckai.helpers.pptx_helper.generate_powerpoint_presentation.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.generate\_powerpoint\_presentation
+===================================================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: generate_powerpoint_presentation

docs/generated/slidedeckai.helpers.pptx_helper.get_flat_list_of_contents.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.get\_flat\_list\_of\_contents
+==============================================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: get_flat_list_of_contents

docs/generated/slidedeckai.helpers.pptx_helper.get_slide_placeholders.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.get\_slide\_placeholders
+=========================================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: get_slide_placeholders

docs/generated/slidedeckai.helpers.pptx_helper.remove_slide_number_from_heading.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.pptx\_helper.remove\_slide\_number\_from\_heading
+=====================================================================
+
+.. currentmodule:: slidedeckai.helpers.pptx_helper
+
+.. autofunction:: remove_slide_number_from_heading

docs/generated/slidedeckai.helpers.pptx_helper.rst

@@ -0,0 +1,34 @@
+slidedeckai.helpers.pptx\_helper
+================================
+===================================
+
+.. currentmodule:: slidedeckai.helpers
+
+.. automodule:: slidedeckai.helpers.pptx_helper
+   :noindex:
+
+.. autosummary::
+   :toctree:
+   :nosignatures:
+
+   
+   add_bulleted_items
+   
+   format_text
+   
+   generate_powerpoint_presentation
+   
+   get_flat_list_of_contents
+   
+   get_slide_placeholders
+   
+   remove_slide_number_from_heading
+   
+
+   
+
+.. automodule:: slidedeckai.helpers.pptx_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: alphabetical

docs/generated/slidedeckai.helpers.text_helper.fix_malformed_json.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.text\_helper.fix\_malformed\_json
+=====================================================
+
+.. currentmodule:: slidedeckai.helpers.text_helper
+
+.. autofunction:: fix_malformed_json

docs/generated/slidedeckai.helpers.text_helper.get_clean_json.rst

@@ -0,0 +1,6 @@
+slidedeckai.helpers.text\_helper.get\_clean\_json
+=================================================
+
+.. currentmodule:: slidedeckai.helpers.text_helper
+
+.. autofunction:: get_clean_json